ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/IO-AIO/AIO.pm

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.70 by root, Tue Oct 24 03:40:38 2006 UTC vs.
Revision 1.234 by root, Mon Aug 13 01:02:30 2012 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
		37	Asynchronous means that operations that can normally block your program
		38	(e.g. reading from disk) will be done asynchronously: the operation
		39	will still block, but you can do something else in the meantime. This
		40	is extremely useful for programs that need to stay interactive even
		41	when doing heavy I/O (GUI programs, high performance network servers
		42	etc.), but can also be used to easily do operations in parallel that are
		43	normally done sequentially, e.g. stat'ing many files, which is much faster
		44	on a RAID volume or over NFS when you do a number of stat operations
		45	concurrently.
		46
		47	While most of this works on all types of file descriptors (for
		48	example sockets), using these functions on file descriptors that
		49	support nonblocking operation (again, sockets, pipes etc.) is
		50	very inefficient. Use an event loop for that (such as the L<EV>
		51	module): IO::AIO will naturally fit into such an event loop itself.
		52
56	Currently, a number of threads are started that execute your read/writes	53	In this version, a number of threads are started that execute your
57	and signal their completion. You don't need thread support in perl, and	54	requests and signal their completion. You don't need thread support
58	the threads created by this module will not be visible to perl. In the	55	in perl, and the threads created by this module will not be visible
59	future, this module might make use of the native aio functions available	56	to perl. In the future, this module might make use of the native aio
60	on many operating systems. However, they are often not well-supported	57	functions available on many operating systems. However, they are often
61	(Linux doesn't allow them on normal files currently, for example),	58	not well-supported or restricted (GNU/Linux doesn't allow them on normal
62	and they would only support aio_read and aio_write, so the remaining	59	files currently, for example), and they would only support aio_read and
63	functionality would have to be implemented using threads anyway.	60	aio_write, so the remaining functionality would have to be implemented
		61	using threads anyway.
64		62
65	Although the module will work with in the presence of other threads,	63	Although the module will work in the presence of other (Perl-) threads,
66	it is currently not reentrant in any way, so use appropriate locking	64	it is currently not reentrant in any way, so use appropriate locking
67	yourself, always call C<poll_cb> from within the same thread, or never	65	yourself, always call C<poll_cb> from within the same thread, or never
68	call C<poll_cb> (or other C<aio_> functions) recursively.	66	call C<poll_cb> (or other C<aio_> functions) recursively.
69		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 Fcntl;
		74	use EV;
		75	use IO::AIO;
		76
		77	# register the IO::AIO callback with EV
		78	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
		79
		80	# queue the request to open /etc/passwd
		81	aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
		82	my $fh = shift
		83	or die "error while opening: $!";
		84
		85	# stat'ing filehandles is generally non-blocking
		86	my $size = -s $fh;
		87
		88	# queue a request to read the file
		89	my $contents;
		90	aio_read $fh, 0, $size, $contents, 0, sub {
		91	$_[0] == $size
		92	or die "short read: $!";
		93
		94	close $fh;
		95
		96	# file contents now in $contents
		97	print $contents;
		98
		99	# exit event loop and program
		100	EV::unloop;
		101	};
		102	};
		103
		104	# possibly queue up other requests, or open GUI windows,
		105	# check for sockets etc. etc.
		106
		107	# process events as long as there are some:
		108	EV::loop;
		109
		110	=head1 REQUEST ANATOMY AND LIFETIME
		111
		112	Every C<aio_*> function creates a request. which is a C data structure not
		113	directly visible to Perl.
		114
		115	If called in non-void context, every request function returns a Perl
		116	object representing the request. In void context, nothing is returned,
		117	which saves a bit of memory.
		118
		119	The perl object is a fairly standard ref-to-hash object. The hash contents
		120	are not used by IO::AIO so you are free to store anything you like in it.
		121
		122	During their existance, aio requests travel through the following states,
		123	in order:
		124
		125	=over 4
		126
		127	=item ready
		128
		129	Immediately after a request is created it is put into the ready state,
		130	waiting for a thread to execute it.
		131
		132	=item execute
		133
		134	A thread has accepted the request for processing and is currently
		135	executing it (e.g. blocking in read).
		136
		137	=item pending
		138
		139	The request has been executed and is waiting for result processing.
		140
		141	While request submission and execution is fully asynchronous, result
		142	processing is not and relies on the perl interpreter calling C<poll_cb>
		143	(or another function with the same effect).
		144
		145	=item result
		146
		147	The request results are processed synchronously by C<poll_cb>.
		148
		149	The C<poll_cb> function will process all outstanding aio requests by
		150	calling their callbacks, freeing memory associated with them and managing
		151	any groups they are contained in.
		152
		153	=item done
		154
		155	Request has reached the end of its lifetime and holds no resources anymore
		156	(except possibly for the Perl object, but its connection to the actual
		157	aio request is severed and calling its methods will either do nothing or
		158	result in a runtime error).
		159
		160	=back
		161
70	=cut	162	=cut
71		163
72	package IO::AIO;	164	package IO::AIO;
73		165
74	no warnings;	166	use Carp ();
75	use strict 'vars';	167
		168	use common::sense;
76		169
77	use base 'Exporter';	170	use base 'Exporter';
78		171
79	BEGIN {	172	BEGIN {
80	our $VERSION = '2.0';	173	our $VERSION = '4.15';
81		174
82	our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat	175	our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close
83	aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink	176	aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx
84	aio_fsync aio_fdatasync aio_readahead aio_rename aio_link aio_move	177	aio_scandir aio_symlink aio_readlink aio_realpath aio_sync
		178	aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_fallocate
		179	aio_pathsync aio_readahead aio_fiemap
		180	aio_rename aio_link aio_move aio_copy aio_group
		181	aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
		182	aio_chmod aio_utime aio_truncate
		183	aio_msync aio_mtouch aio_mlock aio_mlockall
		184	aio_statvfs
85	aio_group aio_nop);	185	aio_wd);
		186
86	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));	187	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
87	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush	188	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
88	min_parallel max_parallel max_outstanding nreqs);	189	min_parallel max_parallel max_idle idle_timeout
		190	nreqs nready npending nthreads
		191	max_poll_time max_poll_reqs
		192	sendfile fadvise madvise
		193	mmap munmap munlock munlockall);
		194
		195	push @AIO_REQ, qw(aio_busy); # not exported
89		196
90	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';	197	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';
91		198
92	require XSLoader;	199	require XSLoader;
93	XSLoader::load ("IO::AIO", $VERSION);	200	XSLoader::load ("IO::AIO", $VERSION);
94	}	201	}
95		202
96	=head1 FUNCTIONS	203	=head1 FUNCTIONS
97		204
98	=head2 AIO FUNCTIONS	205	=head2 QUICK OVERVIEW
		206
		207	This section simply lists the prototypes most of the functions for
		208	quick reference. See the following sections for function-by-function
		209	documentation.
		210
		211	aio_wd $pathname, $callback->($wd)
		212	aio_open $pathname, $flags, $mode, $callback->($fh)
		213	aio_close $fh, $callback->($status)
		214	aio_seek $fh,$offset,$whence, $callback->($offs)
		215	aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
		216	aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
		217	aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
		218	aio_readahead $fh,$offset,$length, $callback->($retval)
		219	aio_stat $fh_or_path, $callback->($status)
		220	aio_lstat $fh, $callback->($status)
		221	aio_statvfs $fh_or_path, $callback->($statvfs)
		222	aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
		223	aio_chown $fh_or_path, $uid, $gid, $callback->($status)
		224	aio_chmod $fh_or_path, $mode, $callback->($status)
		225	aio_truncate $fh_or_path, $offset, $callback->($status)
		226	aio_allocate $fh, $mode, $offset, $len, $callback->($status)
		227	aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
		228	aio_unlink $pathname, $callback->($status)
		229	aio_mknod $pathname, $mode, $dev, $callback->($status)
		230	aio_link $srcpath, $dstpath, $callback->($status)
		231	aio_symlink $srcpath, $dstpath, $callback->($status)
		232	aio_readlink $pathname, $callback->($link)
		233	aio_realpath $pathname, $callback->($link)
		234	aio_rename $srcpath, $dstpath, $callback->($status)
		235	aio_mkdir $pathname, $mode, $callback->($status)
		236	aio_rmdir $pathname, $callback->($status)
		237	aio_readdir $pathname, $callback->($entries)
		238	aio_readdirx $pathname, $flags, $callback->($entries, $flags)
		239	IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST
		240	IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN
		241	aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
		242	aio_load $pathname, $data, $callback->($status)
		243	aio_copy $srcpath, $dstpath, $callback->($status)
		244	aio_move $srcpath, $dstpath, $callback->($status)
		245	aio_rmtree $pathname, $callback->($status)
		246	aio_sync $callback->($status)
		247	aio_syncfs $fh, $callback->($status)
		248	aio_fsync $fh, $callback->($status)
		249	aio_fdatasync $fh, $callback->($status)
		250	aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
		251	aio_pathsync $pathname, $callback->($status)
		252	aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		253	aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		254	aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
		255	aio_mlockall $flags, $callback->($status)
		256	aio_group $callback->(...)
		257	aio_nop $callback->()
		258
		259	$prev_pri = aioreq_pri [$pri]
		260	aioreq_nice $pri_adjust
		261
		262	IO::AIO::poll_wait
		263	IO::AIO::poll_cb
		264	IO::AIO::poll
		265	IO::AIO::flush
		266	IO::AIO::max_poll_reqs $nreqs
		267	IO::AIO::max_poll_time $seconds
		268	IO::AIO::min_parallel $nthreads
		269	IO::AIO::max_parallel $nthreads
		270	IO::AIO::max_idle $nthreads
		271	IO::AIO::idle_timeout $seconds
		272	IO::AIO::max_outstanding $maxreqs
		273	IO::AIO::nreqs
		274	IO::AIO::nready
		275	IO::AIO::npending
		276
		277	IO::AIO::sendfile $ofh, $ifh, $offset, $count
		278	IO::AIO::fadvise $fh, $offset, $len, $advice
		279	IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]
		280	IO::AIO::munmap $scalar
		281	IO::AIO::madvise $scalar, $offset, $length, $advice
		282	IO::AIO::mprotect $scalar, $offset, $length, $protect
		283	IO::AIO::munlock $scalar, $offset = 0, $length = undef
		284	IO::AIO::munlockall
		285
		286	=head2 API NOTES
99		287
100	All the C<aio_*> calls are more or less thin wrappers around the syscall	288	All the C<aio_*> calls are more or less thin wrappers around the syscall
101	with the same name (sans C<aio_>). The arguments are similar or identical,	289	with the same name (sans C<aio_>). The arguments are similar or identical,
102	and they all accept an additional (and optional) C<$callback> argument	290	and they all accept an additional (and optional) C<$callback> argument
103	which must be a code reference. This code reference will get called with	291	which must be a code reference. This code reference will be called after
104	the syscall return code (e.g. most syscalls return C<-1> on error, unlike	292	the syscall has been executed in an asynchronous fashion. The results
105	perl, which usually delivers "false") as it's sole argument when the given	293	of the request will be passed as arguments to the callback (and, if an
106	syscall has been executed asynchronously.	294	error occured, in C<$!>) - for most requests the syscall return code (e.g.
		295	most syscalls return C<-1> on error, unlike perl, which usually delivers
		296	"false").
		297
		298	Some requests (such as C<aio_readdir>) pass the actual results and
		299	communicate failures by passing C<undef>.
107		300
108	All functions expecting a filehandle keep a copy of the filehandle	301	All functions expecting a filehandle keep a copy of the filehandle
109	internally until the request has finished.	302	internally until the request has finished.
110		303
111	All requests return objects of type L<IO::AIO::REQ> that allow further	304	All functions return request objects of type L<IO::AIO::REQ> that allow
112	manipulation of those requests while they are in-flight.	305	further manipulation of those requests while they are in-flight.
113		306
114	The pathnames you pass to these routines I<must> be absolute and	307	The pathnames you pass to these routines I<should> be absolute. The
115	encoded in byte form. The reason for the former is that at the time the	308	reason for this is that at the time the request is being executed, the
116	request is being executed, the current working directory could have	309	current working directory could have changed. Alternatively, you can
117	changed. Alternatively, you can make sure that you never change the	310	make sure that you never change the current working directory anywhere
118	current working directory.	311	in the program and then use relative paths. You can also take advantage
		312	of IO::AIOs working directory abstraction, that lets you specify paths
		313	relative to some previously-opened "working directory object" - see the
		314	description of the C<IO::AIO::WD> class later in this document.
119		315
120	To encode pathnames to byte form, either make sure you either: a)	316	To encode pathnames as octets, either make sure you either: a) always pass
121	always pass in filenames you got from outside (command line, readdir	317	in filenames you got from outside (command line, readdir etc.) without
122	etc.), b) are ASCII or ISO 8859-1, c) use the Encode module and encode	318	tinkering, b) are in your native filesystem encoding, c) use the Encode
123	your pathnames to the locale (or other) encoding in effect in the user	319	module and encode your pathnames to the locale (or other) encoding in
124	environment, d) use Glib::filename_from_unicode on unicode filenames or e)	320	effect in the user environment, d) use Glib::filename_from_unicode on
125	use something else.	321	unicode filenames or e) use something else to ensure your scalar has the
		322	correct contents.
		323
		324	This works, btw. independent of the internal UTF-8 bit, which IO::AIO
		325	handles correctly whether it is set or not.
		326
		327	=head2 AIO REQUEST FUNCTIONS
126		328
127	=over 4	329	=over 4
128		330
129	=item aioreq_pri $pri	331	=item $prev_pri = aioreq_pri [$pri]
130		332
131	Sets the priority for the next aio request. The default priority	333	Returns the priority value that would be used for the next request and, if
		334	C<$pri> is given, sets the priority for the next aio request.
		335
132	is C<0>, the minimum and maximum priorities are C<-4> and C<4>,	336	The default priority is C<0>, the minimum and maximum priorities are C<-4>
133	respectively. Requests with higher priority will be serviced first.	337	and C<4>, respectively. Requests with higher priority will be serviced
		338	first.
134		339
135	The priority will be reset to C<0> after each call to one of the C<aio_>	340	The priority will be reset to C<0> after each call to one of the C<aio_*>
136	functions.	341	functions.
137		342
138	Example: open a file with low priority, then read something from it with	343	Example: open a file with low priority, then read something from it with
139	higher priority so the read request is serviced before other low priority	344	higher priority so the read request is serviced before other low priority
140	open requests (potentially spamming the cache):	345	open requests (potentially spamming the cache):
…		…
147	aio_read $_[0], ..., sub {	352	aio_read $_[0], ..., sub {
148	...	353	...
149	};	354	};
150	};	355	};
151		356
		357
152	=item aioreq_nice $pri_adjust	358	=item aioreq_nice $pri_adjust
153		359
154	Similar to C<aioreq_pri>, but subtracts the given value from the current	360	Similar to C<aioreq_pri>, but subtracts the given value from the current
155	priority, so effects are cumulative.	361	priority, so the effect is cumulative.
		362
156		363
157	=item aio_open $pathname, $flags, $mode, $callback->($fh)	364	=item aio_open $pathname, $flags, $mode, $callback->($fh)
158		365
159	Asynchronously open or create a file and call the callback with a newly	366	Asynchronously open or create a file and call the callback with a newly
160	created filehandle for the file.	367	created filehandle for the file (or C<undef> in case of an error).
161		368
162	The pathname passed to C<aio_open> must be absolute. See API NOTES, above,	369	The pathname passed to C<aio_open> must be absolute. See API NOTES, above,
163	for an explanation.	370	for an explanation.
164		371
165	The C<$flags> argument is a bitmask. See the C<Fcntl> module for a	372	The C<$flags> argument is a bitmask. See the C<Fcntl> module for a
166	list. They are the same as used by C<sysopen>.	373	list. They are the same as used by C<sysopen>.
167		374
168	Likewise, C<$mode> specifies the mode of the newly created file, if it	375	Likewise, C<$mode> specifies the mode of the newly created file, if it
169	didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>,	376	didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>,
170	except that it is mandatory (i.e. use C<0> if you don't create new files,	377	except that it is mandatory (i.e. use C<0> if you don't create new files,
171	and C<0666> or C<0777> if you do).	378	and C<0666> or C<0777> if you do). Note that the C<$mode> will be modified
		379	by the umask in effect then the request is being executed, so better never
		380	change the umask.
172		381
173	Example:	382	Example:
174		383
175	aio_open "/etc/passwd", O_RDONLY, 0, sub {	384	aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
176	if ($_[0]) {	385	if ($_[0]) {
177	print "open successful, fh is $_[0]\n";	386	print "open successful, fh is $_[0]\n";
178	...	387	...
179	} else {	388	} else {
180	die "open failed: $!\n";	389	die "open failed: $!\n";
181	}	390	}
182	};	391	};
183		392
		393	In addition to all the common open modes/flags (C<O_RDONLY>, C<O_WRONLY>,
		394	C<O_RDWR>, C<O_CREAT>, C<O_TRUNC>, C<O_EXCL> and C<O_APPEND>), the
		395	following POSIX and non-POSIX constants are available (missing ones on
		396	your system are, as usual, C<0>):
		397
		398	C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>,
		399	C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>,
		400	C<O_RSYNC>, C<O_SYNC> and C<O_TTY_INIT>.
		401
		402
184	=item aio_close $fh, $callback->($status)	403	=item aio_close $fh, $callback->($status)
185		404
186	Asynchronously close a file and call the callback with the result	405	Asynchronously close a file and call the callback with the result
187	code. I<WARNING:> although accepted, you should not pass in a perl	406	code.
188	filehandle here, as perl will likely close the file descriptor another
189	time when the filehandle is destroyed. Normally, you can safely call perls
190	C<close> or just let filehandles go out of scope.
191		407
192	This is supposed to be a bug in the API, so that might change. It's	408	Unfortunately, you can't do this to perl. Perl I<insists> very strongly on
193	therefore best to avoid this function.	409	closing the file descriptor associated with the filehandle itself.
		410
		411	Therefore, C<aio_close> will not close the filehandle - instead it will
		412	use dup2 to overwrite the file descriptor with the write-end of a pipe
		413	(the pipe fd will be created on demand and will be cached).
		414
		415	Or in other words: the file descriptor will be closed, but it will not be
		416	free for reuse until the perl filehandle is closed.
		417
		418	=cut
		419
		420	=item aio_seek $fh, $offset, $whence, $callback->($offs)
		421
		422	Seeks the filehandle to the new C<$offset>, similarly to perl's
		423	C<sysseek>. The C<$whence> can use the traditional values (C<0> for
		424	C<IO::AIO::SEEK_SET>, C<1> for C<IO::AIO::SEEK_CUR> or C<2> for
		425	C<IO::AIO::SEEK_END>).
		426
		427	The resulting absolute offset will be passed to the callback, or C<-1> in
		428	case of an error.
		429
		430	In theory, the C<$whence> constants could be different than the
		431	corresponding values from L<Fcntl>, but perl guarantees they are the same,
		432	so don't panic.
		433
		434	As a GNU/Linux (and maybe Solaris) extension, also the constants
		435	C<IO::AIO::SEEK_DATA> and C<IO::AIO::SEEK_HOLE> are available, if they
		436	could be found. No guarantees about suitability for use in C<aio_seek> or
		437	Perl's C<sysseek> can be made though, although I would naively assume they
		438	"just work".
194		439
195	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	440	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
196		441
197	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	442	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
198		443
199	Reads or writes C<length> bytes from the specified C<fh> and C<offset>	444	Reads or writes C<$length> bytes from or to the specified C<$fh> and
200	into the scalar given by C<data> and offset C<dataoffset> and calls the	445	C<$offset> into the scalar given by C<$data> and offset C<$dataoffset>
201	callback without the actual number of bytes read (or -1 on error, just	446	and calls the callback without the actual number of bytes read (or -1 on
202	like the syscall).	447	error, just like the syscall).
		448
		449	C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to
		450	offset plus the actual number of bytes read.
		451
		452	If C<$offset> is undefined, then the current file descriptor offset will
		453	be used (and updated), otherwise the file descriptor offset will not be
		454	changed by these calls.
		455
		456	If C<$length> is undefined in C<aio_write>, use the remaining length of
		457	C<$data>.
		458
		459	If C<$dataoffset> is less than zero, it will be counted from the end of
		460	C<$data>.
203		461
204	The C<$data> scalar I<MUST NOT> be modified in any way while the request	462	The C<$data> scalar I<MUST NOT> be modified in any way while the request
205	is outstanding. Modifying it can result in segfaults or WW3 (if the	463	is outstanding. Modifying it can result in segfaults or World War III (if
206	necessary/optional hardware is installed).	464	the necessary/optional hardware is installed).
207		465
208	Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at	466	Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at
209	offset C<0> within the scalar:	467	offset C<0> within the scalar:
210		468
211	aio_read $fh, 7, 15, $buffer, 0, sub {	469	aio_read $fh, 7, 15, $buffer, 0, sub {
212	$_[0] > 0 or die "read error: $!";	470	$_[0] > 0 or die "read error: $!";
213	print "read $_[0] bytes: <$buffer>\n";	471	print "read $_[0] bytes: <$buffer>\n";
214	};	472	};
215		473
216	=item aio_move $srcpath, $dstpath, $callback->($status)
217
218	[EXPERIMENTAL due to internal aio_group use]
219
220	Try to move the I<file> (directories not supported as either source or
221	destination) from C<$srcpath> to C<$dstpath> and call the callback with
222	the C<0> (error) or C<-1> ok.
223
224	This is a composite request that tries to rename(2) the file first. If
225	rename files with C<EXDEV>, it creates the destination file with mode 0200
226	and copies the contents of the source file into it using C<aio_sendfile>,
227	followed by restoring atime, mtime, access mode and uid/gid, in that
228	order, and unlinking the C<$srcpath>.
229
230	If an error occurs, the partial destination file will be unlinked, if
231	possible, except when setting atime, mtime, access mode and uid/gid, where
232	errors are being ignored.
233
234	=cut
235
236	sub aio_move($$$) {
237	my ($src, $dst, $cb) = @_;
238
239	my $grp = aio_group $cb;
240
241	add $grp aio_rename $src, $dst, sub {
242	if ($_[0] && $! == EXDEV) {
243	add $grp aio_open $src, O_RDONLY, 0, sub {
244	if (my $src_fh = $_[0]) {
245	my @stat = stat $src_fh;
246
247	add $grp aio_open $dst, O_WRONLY, 0200, sub {
248	if (my $dst_fh = $_[0]) {
249	add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
250	close $src_fh;
251
252	if ($_[0] == $stat[7]) {
253	utime $stat[8], $stat[9], $dst;
254	chmod $stat[2] & 07777, $dst_fh;
255	chown $stat[4], $stat[5], $dst_fh;
256	close $dst_fh;
257
258	add $grp aio_unlink $src, sub {
259	$grp->result ($_[0]);
260	};
261	} else {
262	my $errno = $!;
263	add $grp aio_unlink $dst, sub {
264	$! = $errno;
265	$grp->result (-1);
266	};
267	}
268	};
269	} else {
270	$grp->result (-1);
271	}
272	},
273
274	} else {
275	$grp->result (-1);
276	}
277	};
278	} else {
279	$grp->result ($_[0]);
280	}
281	};
282
283	$grp
284	}
285		474
286	=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)	475	=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
287		476
288	Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts	477	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	478	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	479	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	480	than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each
292	other.	481	other. The same C<$in_fh> works fine though, as this function does not
		482	move or use the file offset of C<$in_fh>.
293		483
		484	Please note that C<aio_sendfile> can read more bytes from C<$in_fh> than
		485	are written, and there is no way to find out how many more bytes have been
		486	read from C<aio_sendfile> alone, as C<aio_sendfile> only provides the
		487	number of bytes written to C<$out_fh>. Only if the result value equals
		488	C<$length> one can assume that C<$length> bytes have been read.
		489
		490	Unlike with other C<aio_> functions, it makes a lot of sense to use
		491	C<aio_sendfile> on non-blocking sockets, as long as one end (typically
		492	the C<$in_fh>) is a file - the file I/O will then be asynchronous, while
		493	the socket I/O will be non-blocking. Note, however, that you can run
		494	into a trap where C<aio_sendfile> reads some data with readahead, then
		495	fails to write all data, and when the socket is ready the next time, the
		496	data in the cache is already lost, forcing C<aio_sendfile> to again hit
		497	the disk. Explicit C<aio_read> + C<aio_write> let's you better control
		498	resource usage.
		499
294	This call tries to make use of a native C<sendfile> syscall to provide	500	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	501	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.	502	a socket, and C<$in_fh> should refer to an mmap'able file.
297		503
298	If the native sendfile call fails or is not implemented, it will be	504	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	505	C<EINVAL>, C<ENOTSUP>, C<EOPNOTSUPP>, C<EAFNOSUPPORT>, C<EPROTOTYPE> or
		506	C<ENOTSOCK>, it will be emulated, so you can call C<aio_sendfile> on any
300	regardless of the limitations of the operating system.	507	type of filehandle regardless of the limitations of the operating system.
301		508
302	Please note, however, that C<aio_sendfile> can read more bytes from	509	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	510	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	511	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	512	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	513	so you really really should check the return value of C<aio_sendfile> -
307	read.	514	fewre bytes than expected might have been transferred.
		515
308		516
309	=item aio_readahead $fh,$offset,$length, $callback->($retval)	517	=item aio_readahead $fh,$offset,$length, $callback->($retval)
310		518
311	C<aio_readahead> populates the page cache with data from a file so that	519	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>	520	subsequent reads from that file will not block on disk I/O. The C<$offset>
…		…
318	file. The current file offset of the file is left unchanged.	526	file. The current file offset of the file is left unchanged.
319		527
320	If that syscall doesn't exist (likely if your OS isn't Linux) it will be	528	If that syscall doesn't exist (likely if your OS isn't Linux) it will be
321	emulated by simply reading the data, which would have a similar effect.	529	emulated by simply reading the data, which would have a similar effect.
322		530
		531
323	=item aio_stat $fh_or_path, $callback->($status)	532	=item aio_stat $fh_or_path, $callback->($status)
324		533
325	=item aio_lstat $fh, $callback->($status)	534	=item aio_lstat $fh, $callback->($status)
326		535
327	Works like perl's C<stat> or C<lstat> in void context. The callback will	536	Works like perl's C<stat> or C<lstat> in void context. The callback will
…		…
332	for an explanation.	541	for an explanation.
333		542
334	Currently, the stats are always 64-bit-stats, i.e. instead of returning an	543	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	544	error when stat'ing a large file, the results will be silently truncated
336	unless perl itself is compiled with large file support.	545	unless perl itself is compiled with large file support.
		546
		547	To help interpret the mode and dev/rdev stat values, IO::AIO offers the
		548	following constants and functions (if not implemented, the constants will
		549	be C<0> and the functions will either C<croak> or fall back on traditional
		550	behaviour).
		551
		552	C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>,
		553	C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>,
		554	C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>.
337		555
338	Example: Print the length of F</etc/passwd>:	556	Example: Print the length of F</etc/passwd>:
339		557
340	aio_stat "/etc/passwd", sub {	558	aio_stat "/etc/passwd", sub {
341	$_[0] and die "stat failed: $!";	559	$_[0] and die "stat failed: $!";
342	print "size is ", -s _, "\n";	560	print "size is ", -s _, "\n";
343	};	561	};
344		562
		563
		564	=item aio_statvfs $fh_or_path, $callback->($statvfs)
		565
		566	Works like the POSIX C<statvfs> or C<fstatvfs> syscalls, depending on
		567	whether a file handle or path was passed.
		568
		569	On success, the callback is passed a hash reference with the following
		570	members: C<bsize>, C<frsize>, C<blocks>, C<bfree>, C<bavail>, C<files>,
		571	C<ffree>, C<favail>, C<fsid>, C<flag> and C<namemax>. On failure, C<undef>
		572	is passed.
		573
		574	The following POSIX IO::AIO::ST_* constants are defined: C<ST_RDONLY> and
		575	C<ST_NOSUID>.
		576
		577	The following non-POSIX IO::AIO::ST_* flag masks are defined to
		578	their correct value when available, or to C<0> on systems that do
		579	not support them: C<ST_NODEV>, C<ST_NOEXEC>, C<ST_SYNCHRONOUS>,
		580	C<ST_MANDLOCK>, C<ST_WRITE>, C<ST_APPEND>, C<ST_IMMUTABLE>, C<ST_NOATIME>,
		581	C<ST_NODIRATIME> and C<ST_RELATIME>.
		582
		583	Example: stat C</wd> and dump out the data if successful.
		584
		585	aio_statvfs "/wd", sub {
		586	my $f = $_[0]
		587	or die "statvfs: $!";
		588
		589	use Data::Dumper;
		590	say Dumper $f;
		591	};
		592
		593	# result:
		594	{
		595	bsize => 1024,
		596	bfree => 4333064312,
		597	blocks => 10253828096,
		598	files => 2050765568,
		599	flag => 4096,
		600	favail => 2042092649,
		601	bavail => 4333064312,
		602	ffree => 2042092649,
		603	namemax => 255,
		604	frsize => 1024,
		605	fsid => 1810
		606	}
		607
		608
		609	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
		610
		611	Works like perl's C<utime> function (including the special case of $atime
		612	and $mtime being undef). Fractional times are supported if the underlying
		613	syscalls support them.
		614
		615	When called with a pathname, uses utimes(2) if available, otherwise
		616	utime(2). If called on a file descriptor, uses futimes(2) if available,
		617	otherwise returns ENOSYS, so this is not portable.
		618
		619	Examples:
		620
		621	# set atime and mtime to current time (basically touch(1)):
		622	aio_utime "path", undef, undef;
		623	# set atime to current time and mtime to beginning of the epoch:
		624	aio_utime "path", time, undef; # undef==0
		625
		626
		627	=item aio_chown $fh_or_path, $uid, $gid, $callback->($status)
		628
		629	Works like perl's C<chown> function, except that C<undef> for either $uid
		630	or $gid is being interpreted as "do not change" (but -1 can also be used).
		631
		632	Examples:
		633
		634	# same as "chown root path" in the shell:
		635	aio_chown "path", 0, -1;
		636	# same as above:
		637	aio_chown "path", 0, undef;
		638
		639
		640	=item aio_truncate $fh_or_path, $offset, $callback->($status)
		641
		642	Works like truncate(2) or ftruncate(2).
		643
		644
		645	=item aio_allocate $fh, $mode, $offset, $len, $callback->($status)
		646
		647	Allocates or freed disk space according to the C<$mode> argument. See the
		648	linux C<fallocate> docuemntation for details.
		649
		650	C<$mode> can currently be C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE>
		651	to allocate space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE |
		652	IO::AIO::FALLOC_FL_KEEP_SIZE>, to deallocate a file range.
		653
		654	The file system block size used by C<fallocate> is presumably the
		655	C<f_bsize> returned by C<statvfs>.
		656
		657	If C<fallocate> isn't available or cannot be emulated (currently no
		658	emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>.
		659
		660
		661	=item aio_chmod $fh_or_path, $mode, $callback->($status)
		662
		663	Works like perl's C<chmod> function.
		664
		665
345	=item aio_unlink $pathname, $callback->($status)	666	=item aio_unlink $pathname, $callback->($status)
346		667
347	Asynchronously unlink (delete) a file and call the callback with the	668	Asynchronously unlink (delete) a file and call the callback with the
348	result code.	669	result code.
349		670
		671
		672	=item aio_mknod $pathname, $mode, $dev, $callback->($status)
		673
		674	[EXPERIMENTAL]
		675
		676	Asynchronously create a device node (or fifo). See mknod(2).
		677
		678	The only (POSIX-) portable way of calling this function is:
		679
		680	aio_mknod $pathname, IO::AIO::S_IFIFO | $mode, 0, sub { ...
		681
		682	See C<aio_stat> for info about some potentially helpful extra constants
		683	and functions.
		684
350	=item aio_link $srcpath, $dstpath, $callback->($status)	685	=item aio_link $srcpath, $dstpath, $callback->($status)
351		686
352	Asynchronously create a new link to the existing object at C<$srcpath> at	687	Asynchronously create a new link to the existing object at C<$srcpath> at
353	the path C<$dstpath> and call the callback with the result code.	688	the path C<$dstpath> and call the callback with the result code.
354		689
		690
355	=item aio_symlink $srcpath, $dstpath, $callback->($status)	691	=item aio_symlink $srcpath, $dstpath, $callback->($status)
356		692
357	Asynchronously create a new symbolic link to the existing object at C<$srcpath> at	693	Asynchronously create a new symbolic link to the existing object at C<$srcpath> at
358	the path C<$dstpath> and call the callback with the result code.	694	the path C<$dstpath> and call the callback with the result code.
359		695
		696
		697	=item aio_readlink $pathname, $callback->($link)
		698
		699	Asynchronously read the symlink specified by C<$path> and pass it to
		700	the callback. If an error occurs, nothing or undef gets passed to the
		701	callback.
		702
		703
		704	=item aio_realpath $pathname, $callback->($path)
		705
		706	Asynchronously make the path absolute and resolve any symlinks in
		707	C<$path>. The resulting path only consists of directories (Same as
		708	L<Cwd::realpath>).
		709
		710	This request can be used to get the absolute path of the current working
		711	directory by passing it a path of F<.> (a single dot).
		712
		713
360	=item aio_rename $srcpath, $dstpath, $callback->($status)	714	=item aio_rename $srcpath, $dstpath, $callback->($status)
361		715
362	Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as	716	Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
363	rename(2) and call the callback with the result code.	717	rename(2) and call the callback with the result code.
364		718
		719
		720	=item aio_mkdir $pathname, $mode, $callback->($status)
		721
		722	Asynchronously mkdir (create) a directory and call the callback with
		723	the result code. C<$mode> will be modified by the umask at the time the
		724	request is executed, so do not change your umask.
		725
		726
365	=item aio_rmdir $pathname, $callback->($status)	727	=item aio_rmdir $pathname, $callback->($status)
366		728
367	Asynchronously rmdir (delete) a directory and call the callback with the	729	Asynchronously rmdir (delete) a directory and call the callback with the
368	result code.	730	result code.
		731
369		732
370	=item aio_readdir $pathname, $callback->($entries)	733	=item aio_readdir $pathname, $callback->($entries)
371		734
372	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire	735	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
373	directory (i.e. opendir + readdir + closedir). The entries will not be	736	directory (i.e. opendir + readdir + closedir). The entries will not be
374	sorted, and will B<NOT> include the C<.> and C<..> entries.	737	sorted, and will B<NOT> include the C<.> and C<..> entries.
375		738
376	The callback a single argument which is either C<undef> or an array-ref	739	The callback is passed a single argument which is either C<undef> or an
377	with the filenames.	740	array-ref with the filenames.
378		741
		742
		743	=item aio_readdirx $pathname, $flags, $callback->($entries, $flags)
		744
		745	Quite similar to C<aio_readdir>, but the C<$flags> argument allows one to
		746	tune behaviour and output format. In case of an error, C<$entries> will be
		747	C<undef>.
		748
		749	The flags are a combination of the following constants, ORed together (the
		750	flags will also be passed to the callback, possibly modified):
		751
		752	=over 4
		753
		754	=item IO::AIO::READDIR_DENTS
		755
		756	When this flag is off, then the callback gets an arrayref consisting of
		757	names only (as with C<aio_readdir>), otherwise it gets an arrayref with
		758	C<[$name, $type, $inode]> arrayrefs, each describing a single directory
		759	entry in more detail.
		760
		761	C<$name> is the name of the entry.
		762
		763	C<$type> is one of the C<IO::AIO::DT_xxx> constants:
		764
		765	C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>,
		766	C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>,
		767	C<IO::AIO::DT_WHT>.
		768
		769	C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to
		770	know, you have to run stat yourself. Also, for speed reasons, the C<$type>
		771	scalars are read-only: you can not modify them.
		772
		773	C<$inode> is the inode number (which might not be exact on systems with 64
		774	bit inode numbers and 32 bit perls). This field has unspecified content on
		775	systems that do not deliver the inode information.
		776
		777	=item IO::AIO::READDIR_DIRS_FIRST
		778
		779	When this flag is set, then the names will be returned in an order where
		780	likely directories come first, in optimal stat order. This is useful when
		781	you need to quickly find directories, or you want to find all directories
		782	while avoiding to stat() each entry.
		783
		784	If the system returns type information in readdir, then this is used
		785	to find directories directly. Otherwise, likely directories are names
		786	beginning with ".", or otherwise names with no dots, of which names with
		787	short names are tried first.
		788
		789	=item IO::AIO::READDIR_STAT_ORDER
		790
		791	When this flag is set, then the names will be returned in an order
		792	suitable for stat()'ing each one. That is, when you plan to stat()
		793	all files in the given directory, then the returned order will likely
		794	be fastest.
		795
		796	If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, then
		797	the likely dirs come first, resulting in a less optimal stat order.
		798
		799	=item IO::AIO::READDIR_FOUND_UNKNOWN
		800
		801	This flag should not be set when calling C<aio_readdirx>. Instead, it
		802	is being set by C<aio_readdirx>, when any of the C<$type>'s found were
		803	C<IO::AIO::DT_UNKNOWN>. The absence of this flag therefore indicates that all
		804	C<$type>'s are known, which can be used to speed up some algorithms.
		805
		806	=back
		807
		808
		809	=item aio_load $pathname, $data, $callback->($status)
		810
		811	This is a composite request that tries to fully load the given file into
		812	memory. Status is the same as with aio_read.
		813
		814	=cut
		815
		816	sub aio_load($$;$) {
		817	my ($path, undef, $cb) = @_;
		818	my $data = \$_[1];
		819
		820	my $pri = aioreq_pri;
		821	my $grp = aio_group $cb;
		822
		823	aioreq_pri $pri;
		824	add $grp aio_open $path, O_RDONLY, 0, sub {
		825	my $fh = shift
		826	or return $grp->result (-1);
		827
		828	aioreq_pri $pri;
		829	add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
		830	$grp->result ($_[0]);
		831	};
		832	};
		833
		834	$grp
		835	}
		836
		837	=item aio_copy $srcpath, $dstpath, $callback->($status)
		838
		839	Try to copy the I<file> (directories not supported as either source or
		840	destination) from C<$srcpath> to C<$dstpath> and call the callback with
		841	a status of C<0> (ok) or C<-1> (error, see C<$!>).
		842
		843	This is a composite request that creates the destination file with
		844	mode 0200 and copies the contents of the source file into it using
		845	C<aio_sendfile>, followed by restoring atime, mtime, access mode and
		846	uid/gid, in that order.
		847
		848	If an error occurs, the partial destination file will be unlinked, if
		849	possible, except when setting atime, mtime, access mode and uid/gid, where
		850	errors are being ignored.
		851
		852	=cut
		853
		854	sub aio_copy($$;$) {
		855	my ($src, $dst, $cb) = @_;
		856
		857	my $pri = aioreq_pri;
		858	my $grp = aio_group $cb;
		859
		860	aioreq_pri $pri;
		861	add $grp aio_open $src, O_RDONLY, 0, sub {
		862	if (my $src_fh = $_[0]) {
		863	my @stat = stat $src_fh; # hmm, might block over nfs?
		864
		865	aioreq_pri $pri;
		866	add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
		867	if (my $dst_fh = $_[0]) {
		868	aioreq_pri $pri;
		869	add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
		870	if ($_[0] == $stat[7]) {
		871	$grp->result (0);
		872	close $src_fh;
		873
		874	my $ch = sub {
		875	aioreq_pri $pri;
		876	add $grp aio_chmod $dst_fh, $stat[2] & 07777, sub {
		877	aioreq_pri $pri;
		878	add $grp aio_chown $dst_fh, $stat[4], $stat[5], sub {
		879	aioreq_pri $pri;
		880	add $grp aio_close $dst_fh;
		881	}
		882	};
		883	};
		884
		885	aioreq_pri $pri;
		886	add $grp aio_utime $dst_fh, $stat[8], $stat[9], sub {
		887	if ($_[0] < 0 && $! == ENOSYS) {
		888	aioreq_pri $pri;
		889	add $grp aio_utime $dst, $stat[8], $stat[9], $ch;
		890	} else {
		891	$ch->();
		892	}
		893	};
		894	} else {
		895	$grp->result (-1);
		896	close $src_fh;
		897	close $dst_fh;
		898
		899	aioreq $pri;
		900	add $grp aio_unlink $dst;
		901	}
		902	};
		903	} else {
		904	$grp->result (-1);
		905	}
		906	},
		907
		908	} else {
		909	$grp->result (-1);
		910	}
		911	};
		912
		913	$grp
		914	}
		915
		916	=item aio_move $srcpath, $dstpath, $callback->($status)
		917
		918	Try to move the I<file> (directories not supported as either source or
		919	destination) from C<$srcpath> to C<$dstpath> and call the callback with
		920	a status of C<0> (ok) or C<-1> (error, see C<$!>).
		921
		922	This is a composite request that tries to rename(2) the file first; if
		923	rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if
		924	that is successful, unlinks the C<$srcpath>.
		925
		926	=cut
		927
		928	sub aio_move($$;$) {
		929	my ($src, $dst, $cb) = @_;
		930
		931	my $pri = aioreq_pri;
		932	my $grp = aio_group $cb;
		933
		934	aioreq_pri $pri;
		935	add $grp aio_rename $src, $dst, sub {
		936	if ($_[0] && $! == EXDEV) {
		937	aioreq_pri $pri;
		938	add $grp aio_copy $src, $dst, sub {
		939	$grp->result ($_[0]);
		940
		941	unless ($_[0]) {
		942	aioreq_pri $pri;
		943	add $grp aio_unlink $src;
		944	}
		945	};
		946	} else {
		947	$grp->result ($_[0]);
		948	}
		949	};
		950
		951	$grp
		952	}
		953
379	=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)	954	=item aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
380
381	[EXPERIMENTAL due to internal aio_group use]
382		955
383	Scans a directory (similar to C<aio_readdir>) but additionally tries to	956	Scans a directory (similar to C<aio_readdir>) but additionally tries to
384	separate the entries of directory C<$path> into two sets of names, ones	957	efficiently separate the entries of directory C<$path> into two sets of
385	you can recurse into (directories or links to them), and ones you cannot	958	names, directories you can recurse into (directories), and ones you cannot
386	recurse into (everything else).	959	recurse into (everything else, including symlinks to directories).
387		960
388	C<aio_scandir> is a composite request that creates of many sub requests_	961	C<aio_scandir> is a composite request that creates of many sub requests_
389	C<$maxreq> specifies the maximum number of outstanding aio requests that	962	C<$maxreq> specifies the maximum number of outstanding aio requests that
390	this function generates. If it is C<< <= 0 >>, then a suitable default	963	this function generates. If it is C<< <= 0 >>, then a suitable default
391	will be chosen (currently 6).	964	will be chosen (currently 4).
392		965
393	On error, the callback is called without arguments, otherwise it receives	966	On error, the callback is called without arguments, otherwise it receives
394	two array-refs with path-relative entry names.	967	two array-refs with path-relative entry names.
395		968
396	Example:	969	Example:
…		…
403		976
404	Implementation notes.	977	Implementation notes.
405		978
406	The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can.	979	The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can.
407		980
		981	If readdir returns file type information, then this is used directly to
		982	find directories.
		983
408	After reading the directory, the modification time, size etc. of the	984	Otherwise, after reading the directory, the modification time, size etc.
409	directory before and after the readdir is checked, and if they match (and	985	of the directory before and after the readdir is checked, and if they
410	isn't the current time), the link count will be used to decide how many	986	match (and isn't the current time), the link count will be used to decide
411	entries are directories (if >= 2). Otherwise, no knowledge of the number	987	how many entries are directories (if >= 2). Otherwise, no knowledge of the
412	of subdirectories will be assumed.	988	number of subdirectories will be assumed.
413		989
414	Then entries will be sorted into likely directories (everything without	990	Then entries will be sorted into likely directories a non-initial dot
415	a non-initial dot currently) and likely non-directories (everything	991	currently) and likely non-directories (see C<aio_readdirx>). Then every
416	else). Then every entry plus an appended C</.> will be C<stat>'ed,	992	entry plus an appended C</.> will be C<stat>'ed, likely directories first,
417	likely directories first. If that succeeds, it assumes that the entry	993	in order of their inode numbers. If that succeeds, it assumes that the
418	is a directory or a symlink to directory (which will be checked	994	entry is a directory or a symlink to directory (which will be checked
419	seperately). This is often faster than stat'ing the entry itself because	995	separately). This is often faster than stat'ing the entry itself because
420	filesystems might detect the type of the entry without reading the inode	996	filesystems might detect the type of the entry without reading the inode
421	data (e.g. ext2fs filetype feature).	997	data (e.g. ext2fs filetype feature), even on systems that cannot return
		998	the filetype information on readdir.
422		999
423	If the known number of directories (link count - 2) has been reached, the	1000	If the known number of directories (link count - 2) has been reached, the
424	rest of the entries is assumed to be non-directories.	1001	rest of the entries is assumed to be non-directories.
425		1002
426	This only works with certainty on POSIX (= UNIX) filesystems, which	1003	This only works with certainty on POSIX (= UNIX) filesystems, which
…		…
430	as those tend to return 0 or 1 as link counts, which disables the	1007	as those tend to return 0 or 1 as link counts, which disables the
431	directory counting heuristic.	1008	directory counting heuristic.
432		1009
433	=cut	1010	=cut
434		1011
435	sub aio_scandir($$$) {	1012	sub aio_scandir($$;$) {
436	my ($path, $maxreq, $cb) = @_;	1013	my ($path, $maxreq, $cb) = @_;
437		1014
		1015	my $pri = aioreq_pri;
		1016
438	my $grp = aio_group $cb;	1017	my $grp = aio_group $cb;
439		1018
440	$maxreq = 6 if $maxreq <= 0;	1019	$maxreq = 4 if $maxreq <= 0;
441		1020
442	# stat once	1021	# get a wd object
		1022	aioreq_pri $pri;
443	add $grp aio_stat $path, sub {	1023	add $grp aio_wd $path, sub {
		1024	$_[0]
		1025	or return $grp->result ();
		1026
		1027	my $wd = [shift, "."];
		1028
		1029	# stat once
		1030	aioreq_pri $pri;
		1031	add $grp aio_stat $wd, sub {
444	return $grp->result () if $_[0];	1032	return $grp->result () if $_[0];
445	my $now = time;	1033	my $now = time;
446	my $hash1 = join ":", (stat _)[0,1,3,7,9];	1034	my $hash1 = join ":", (stat _)[0,1,3,7,9];
447		1035
448	# read the directory entries	1036	# read the directory entries
449	add $grp aio_readdir $path, sub {	1037	aioreq_pri $pri;
		1038	add $grp aio_readdirx $wd, READDIR_DIRS_FIRST, sub {
450	my $entries = shift	1039	my $entries = shift
451	or return $grp->result ();	1040	or return $grp->result ();
452		1041
453	# stat the dir another time	1042	# stat the dir another time
		1043	aioreq_pri $pri;
454	add $grp aio_stat $path, sub {	1044	add $grp aio_stat $wd, sub {
455	my $hash2 = join ":", (stat _)[0,1,3,7,9];	1045	my $hash2 = join ":", (stat _)[0,1,3,7,9];
456		1046
457	my $ndirs;	1047	my $ndirs;
458		1048
459	# take the slow route if anything looks fishy	1049	# take the slow route if anything looks fishy
460	if ($hash1 ne $hash2 or (stat _)[9] == $now) {	1050	if ($hash1 ne $hash2 or (stat _)[9] == $now) {
461	$ndirs = -1;	1051	$ndirs = -1;
462	} else {	1052	} else {
463	# if nlink == 2, we are finished	1053	# if nlink == 2, we are finished
464	# on non-posix-fs's, we rely on nlink < 2	1054	# for non-posix-fs's, we rely on nlink < 2
465	$ndirs = (stat _)[3] - 2	1055	$ndirs = (stat _)[3] - 2
466	or return $grp->result ([], $entries);	1056	or return $grp->result ([], $entries);
467	}	1057	}
468		1058
469	# sort into likely dirs and likely nondirs
470	# dirs == files without ".", short entries first
471	$entries = [map $_->[0],
472	sort { $b->[1] cmp $a->[1] }
473	map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
474	@$entries];
475
476	my (@dirs, @nondirs);	1059	my (@dirs, @nondirs);
477		1060
478	my ($statcb, $schedcb);
479	my $nreq = 0;
480
481	my $statgrp = add $grp aio_group;	1061	my $statgrp = add $grp aio_group sub {
482
483	$schedcb = sub {
484	if (@$entries) {
485	if ($nreq < $maxreq) {
486	my $ent = pop @$entries;
487	$nreq++;
488	add $statgrp aio_stat "$path/$ent/.", sub { $statcb->($_[0], $ent) };
489	}
490	} elsif (!$nreq) {
491	# finished
492	$statgrp->cancel;
493	undef $statcb;
494	undef $schedcb;
495	$grp->result (\@dirs, \@nondirs);	1062	$grp->result (\@dirs, \@nondirs);
496	}	1063	};
		1064
		1065	limit $statgrp $maxreq;
		1066	feed $statgrp sub {
		1067	return unless @$entries;
		1068	my $entry = shift @$entries;
		1069
		1070	aioreq_pri $pri;
		1071	$wd->[1] = "$entry/.";
		1072	add $statgrp aio_stat $wd, sub {
		1073	if ($_[0] < 0) {
		1074	push @nondirs, $entry;
		1075	} else {
		1076	# need to check for real directory
		1077	aioreq_pri $pri;
		1078	$wd->[1] = $entry;
		1079	add $statgrp aio_lstat $wd, sub {
		1080	if (-d _) {
		1081	push @dirs, $entry;
		1082
		1083	unless (--$ndirs) {
		1084	push @nondirs, @$entries;
		1085	feed $statgrp;
		1086	}
		1087	} else {
		1088	push @nondirs, $entry;
		1089	}
		1090	}
		1091	}
		1092	};
		1093	};
497	};	1094	};
498	$statcb = sub {
499	my ($status, $entry) = @_;
500
501	if ($status < 0) {
502	$nreq--;
503	push @nondirs, $entry;
504	&$schedcb;
505	} else {
506	# need to check for real directory
507	add $grp aio_lstat "$path/$entry", sub {
508	$nreq--;
509
510	if (-d _) {
511	push @dirs, $entry;
512
513	if (!--$ndirs) {
514	push @nondirs, @$entries;
515	$entries = [];
516	}
517	} else {
518	push @nondirs, $entry;
519	}
520
521	&$schedcb;
522	}
523	}
524	};
525
526	&$schedcb while @$entries && $nreq < $maxreq;
527	};	1095	};
528	};	1096	};
529	};	1097	};
530		1098
531	$grp	1099	$grp
532	}	1100	}
533		1101
		1102	=item aio_rmtree $pathname, $callback->($status)
		1103
		1104	Delete a directory tree starting (and including) C<$path>, return the
		1105	status of the final C<rmdir> only. This is a composite request that
		1106	uses C<aio_scandir> to recurse into and rmdir directories, and unlink
		1107	everything else.
		1108
		1109	=cut
		1110
		1111	sub aio_rmtree;
		1112	sub aio_rmtree($;$) {
		1113	my ($path, $cb) = @_;
		1114
		1115	my $pri = aioreq_pri;
		1116	my $grp = aio_group $cb;
		1117
		1118	aioreq_pri $pri;
		1119	add $grp aio_scandir $path, 0, sub {
		1120	my ($dirs, $nondirs) = @_;
		1121
		1122	my $dirgrp = aio_group sub {
		1123	add $grp aio_rmdir $path, sub {
		1124	$grp->result ($_[0]);
		1125	};
		1126	};
		1127
		1128	(aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
		1129	(aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
		1130
		1131	add $grp $dirgrp;
		1132	};
		1133
		1134	$grp
		1135	}
		1136
		1137	=item aio_sync $callback->($status)
		1138
		1139	Asynchronously call sync and call the callback when finished.
		1140
534	=item aio_fsync $fh, $callback->($status)	1141	=item aio_fsync $fh, $callback->($status)
535		1142
536	Asynchronously call fsync on the given filehandle and call the callback	1143	Asynchronously call fsync on the given filehandle and call the callback
537	with the fsync result code.	1144	with the fsync result code.
538		1145
…		…
542	callback with the fdatasync result code.	1149	callback with the fdatasync result code.
543		1150
544	If this call isn't available because your OS lacks it or it couldn't be	1151	If this call isn't available because your OS lacks it or it couldn't be
545	detected, it will be emulated by calling C<fsync> instead.	1152	detected, it will be emulated by calling C<fsync> instead.
546		1153
		1154	=item aio_syncfs $fh, $callback->($status)
		1155
		1156	Asynchronously call the syncfs syscall to sync the filesystem associated
		1157	to the given filehandle and call the callback with the syncfs result
		1158	code. If syncfs is not available, calls sync(), but returns C<-1> and sets
		1159	errno to C<ENOSYS> nevertheless.
		1160
		1161	=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
		1162
		1163	Sync the data portion of the file specified by C<$offset> and C<$length>
		1164	to disk (but NOT the metadata), by calling the Linux-specific
		1165	sync_file_range call. If sync_file_range is not available or it returns
		1166	ENOSYS, then fdatasync or fsync is being substituted.
		1167
		1168	C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,
		1169	C<IO::AIO::SYNC_FILE_RANGE_WRITE> and
		1170	C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range
		1171	manpage for details.
		1172
		1173	=item aio_pathsync $pathname, $callback->($status)
		1174
		1175	This request tries to open, fsync and close the given path. This is a
		1176	composite request intended to sync directories after directory operations
		1177	(E.g. rename). This might not work on all operating systems or have any
		1178	specific effect, but usually it makes sure that directory changes get
		1179	written to disc. It works for anything that can be opened for read-only,
		1180	not just directories.
		1181
		1182	Future versions of this function might fall back to other methods when
		1183	C<fsync> on the directory fails (such as calling C<sync>).
		1184
		1185	Passes C<0> when everything went ok, and C<-1> on error.
		1186
		1187	=cut
		1188
		1189	sub aio_pathsync($;$) {
		1190	my ($path, $cb) = @_;
		1191
		1192	my $pri = aioreq_pri;
		1193	my $grp = aio_group $cb;
		1194
		1195	aioreq_pri $pri;
		1196	add $grp aio_open $path, O_RDONLY, 0, sub {
		1197	my ($fh) = @_;
		1198	if ($fh) {
		1199	aioreq_pri $pri;
		1200	add $grp aio_fsync $fh, sub {
		1201	$grp->result ($_[0]);
		1202
		1203	aioreq_pri $pri;
		1204	add $grp aio_close $fh;
		1205	};
		1206	} else {
		1207	$grp->result (-1);
		1208	}
		1209	};
		1210
		1211	$grp
		1212	}
		1213
		1214	=item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		1215
		1216	This is a rather advanced IO::AIO call, which only works on mmap(2)ed
		1217	scalars (see the C<IO::AIO::mmap> function, although it also works on data
		1218	scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the
		1219	scalar must only be modified in-place while an aio operation is pending on
		1220	it).
		1221
		1222	It calls the C<msync> function of your OS, if available, with the memory
		1223	area starting at C<$offset> in the string and ending C<$length> bytes
		1224	later. If C<$length> is negative, counts from the end, and if C<$length>
		1225	is C<undef>, then it goes till the end of the string. The flags can be
		1226	a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and
		1227	C<IO::AIO::MS_SYNC>.
		1228
		1229	=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		1230
		1231	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
		1232	scalars.
		1233
		1234	It touches (reads or writes) all memory pages in the specified
		1235	range inside the scalar. All caveats and parameters are the same
		1236	as for C<aio_msync>, above, except for flags, which must be either
		1237	C<0> (which reads all pages and ensures they are instantiated) or
		1238	C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and
		1239	writing an octet from it, which dirties the page).
		1240
		1241	=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
		1242
		1243	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
		1244	scalars.
		1245
		1246	It reads in all the pages of the underlying storage into memory (if any)
		1247	and locks them, so they are not getting swapped/paged out or removed.
		1248
		1249	If C<$length> is undefined, then the scalar will be locked till the end.
		1250
		1251	On systems that do not implement C<mlock>, this function returns C<-1>
		1252	and sets errno to C<ENOSYS>.
		1253
		1254	Note that the corresponding C<munlock> is synchronous and is
		1255	documented under L<MISCELLANEOUS FUNCTIONS>.
		1256
		1257	Example: open a file, mmap and mlock it - both will be undone when
		1258	C<$data> gets destroyed.
		1259
		1260	open my $fh, "<", $path or die "$path: $!";
		1261	my $data;
		1262	IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;
		1263	aio_mlock $data; # mlock in background
		1264
		1265	=item aio_mlockall $flags, $callback->($status)
		1266
		1267	Calls the C<mlockall> function with the given C<$flags> (a combination of
		1268	C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>).
		1269
		1270	On systems that do not implement C<mlockall>, this function returns C<-1>
		1271	and sets errno to C<ENOSYS>.
		1272
		1273	Note that the corresponding C<munlockall> is synchronous and is
		1274	documented under L<MISCELLANEOUS FUNCTIONS>.
		1275
		1276	Example: asynchronously lock all current and future pages into memory.
		1277
		1278	aio_mlockall IO::AIO::MCL_FUTURE;
		1279
		1280	=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
		1281
		1282	Queries the extents of the given file (by calling the Linux C<FIEMAP>
		1283	ioctl, see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If
		1284	the ioctl is not available on your OS, then this request will fail with
		1285	C<ENOSYS>.
		1286
		1287	C<$start> is the starting offset to query extents for, C<$length> is the
		1288	size of the range to query - if it is C<undef>, then the whole file will
		1289	be queried.
		1290
		1291	C<$flags> is a combination of flags (C<IO::AIO::FIEMAP_FLAG_SYNC> or
		1292	C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also
		1293	exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query
		1294	the data portion.
		1295
		1296	C<$count> is the maximum number of extent records to return. If it is
		1297	C<undef>, then IO::AIO queries all extents of the range. As a very special
		1298	case, if it is C<0>, then the callback receives the number of extents
		1299	instead of the extents themselves (which is unreliable, see below).
		1300
		1301	If an error occurs, the callback receives no arguments. The special
		1302	C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.
		1303
		1304	Otherwise, the callback receives an array reference with extent
		1305	structures. Each extent structure is an array reference itself, with the
		1306	following members:
		1307
		1308	[$logical, $physical, $length, $flags]
		1309
		1310	Flags is any combination of the following flag values (typically either C<0>
		1311	or C<IO::AIO::FIEMAP_EXTENT_LAST> (1)):
		1312
		1313	C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,
		1314	C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,
		1315	C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,
		1316	C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,
		1317	C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or
		1318	C<IO::AIO::FIEMAP_EXTENT_SHARED>.
		1319
		1320	At the time of this writing (Linux 3.2), this requets is unreliable unless
		1321	C<$count> is C<undef>, as the kernel has all sorts of bugs preventing
		1322	it to return all extents of a range for files with large number of
		1323	extents. The code works around all these issues if C<$count> is undef.
		1324
547	=item aio_group $callback->(...)	1325	=item aio_group $callback->(...)
548
549	[EXPERIMENTAL]
550		1326
551	This is a very special aio request: Instead of doing something, it is a	1327	This is a very special aio request: Instead of doing something, it is a
552	container for other aio requests, which is useful if you want to bundle	1328	container for other aio requests, which is useful if you want to bundle
553	many requests into a single, composite, request.	1329	many requests into a single, composite, request with a definite callback
		1330	and the ability to cancel the whole request with its subrequests.
554		1331
555	Returns an object of class L<IO::AIO::GRP>. See its documentation below	1332	Returns an object of class L<IO::AIO::GRP>. See its documentation below
556	for more info.	1333	for more info.
557		1334
558	Example:	1335	Example:
…		…
577	phase and still requires a worker thread. Thus, the callback will not	1354	phase and still requires a worker thread. Thus, the callback will not
578	be executed immediately but only after other requests in the queue have	1355	be executed immediately but only after other requests in the queue have
579	entered their execution phase. This can be used to measure request	1356	entered their execution phase. This can be used to measure request
580	latency.	1357	latency.
581		1358
582	=item IO::AIO::aio_sleep $fractional_seconds, $callback->() *NOT EXPORTED*	1359	=item IO::AIO::aio_busy $fractional_seconds, $callback->() *NOT EXPORTED*
583		1360
584	Mainly used for debugging and benchmarking, this aio request puts one of	1361	Mainly used for debugging and benchmarking, this aio request puts one of
585	the request workers to sleep for the given time.	1362	the request workers to sleep for the given time.
586		1363
587	While it is theoretically handy to have simple I/O scheduling requests	1364	While it is theoretically handy to have simple I/O scheduling requests
588	like sleep and file handle readable/writable, the overhead this creates	1365	like sleep and file handle readable/writable, the overhead this creates is
589	is immense, so do not use this function except to put your application	1366	immense (it blocks a thread for a long time) so do not use this function
590	under artificial I/O pressure.	1367	except to put your application under artificial I/O pressure.
591		1368
592	=back	1369	=back
		1370
		1371
		1372	=head2 IO::AIO::WD - multiple working directories
		1373
		1374	Your process only has one current working directory, which is used by all
		1375	threads. This makes it hard to use relative paths (some other component
		1376	could call C<chdir> at any time, and it is hard to control when the path
		1377	will be used by IO::AIO).
		1378
		1379	One solution for this is to always use absolute paths. This usually works,
		1380	but can be quite slow (the kernel has to walk the whole path on every
		1381	access), and can also be a hassle to implement.
		1382
		1383	Newer POSIX systems have a number of functions (openat, fdopendir,
		1384	futimensat and so on) that make it possible to specify working directories
		1385	per operation.
		1386
		1387	For portability, and because the clowns who "designed", or shall I write,
		1388	perpetrated this new interface were obviously half-drunk, this abstraction
		1389	cannot be perfect, though.
		1390
		1391	IO::AIO allows you to convert directory paths into a so-called IO::AIO::WD
		1392	object. This object stores the canonicalised, absolute version of the
		1393	path, and on systems that allow it, also a directory file descriptor.
		1394
		1395	Everywhere where a pathname is accepted by IO::AIO (e.g. in C<aio_stat>
		1396	or C<aio_unlink>), one can specify an array reference with an IO::AIO::WD
		1397	object and a pathname instead (or the IO::AIO::WD object alone, which
		1398	gets interpreted as C<[$wd, "."]>). If the pathname is absolute, the
		1399	IO::AIO::WD object is ignored, otherwise the pathname is resolved relative
		1400	to that IO::AIO::WD object.
		1401
		1402	For example, to get a wd object for F</etc> and then stat F<passwd>
		1403	inside, you would write:
		1404
		1405	aio_wd "/etc", sub {
		1406	my $etcdir = shift;
		1407
		1408	# although $etcdir can be undef on error, there is generally no reason
		1409	# to check for errors here, as aio_stat will fail with ENOENT
		1410	# when $etcdir is undef.
		1411
		1412	aio_stat [$etcdir, "passwd"], sub {
		1413	# yay
		1414	};
		1415	};
		1416
		1417	That C<aio_wd> is a request and not a normal function shows that creating
		1418	an IO::AIO::WD object is itself a potentially blocking operation, which is
		1419	why it is done asynchronously.
		1420
		1421	To stat the directory obtained with C<aio_wd> above, one could write
		1422	either of the following three request calls:
		1423
		1424	aio_lstat "/etc" , sub { ... # pathname as normal string
		1425	aio_lstat [$wd, "."], sub { ... # "." relative to $wd (i.e. $wd itself)
		1426	aio_lstat $wd , sub { ... # shorthand for the previous
		1427
		1428	As with normal pathnames, IO::AIO keeps a copy of the working directory
		1429	object and the pathname string, so you could write the following without
		1430	causing any issues due to C<$path> getting reused:
		1431
		1432	my $path = [$wd, undef];
		1433
		1434	for my $name (qw(abc def ghi)) {
		1435	$path->[1] = $name;
		1436	aio_stat $path, sub {
		1437	# ...
		1438	};
		1439	}
		1440
		1441	There are some caveats: when directories get renamed (or deleted), the
		1442	pathname string doesn't change, so will point to the new directory (or
		1443	nowhere at all), while the directory fd, if available on the system,
		1444	will still point to the original directory. Most functions accepting a
		1445	pathname will use the directory fd on newer systems, and the string on
		1446	older systems. Some functions (such as realpath) will always rely on the
		1447	string form of the pathname.
		1448
		1449	So this fucntionality is mainly useful to get some protection against
		1450	C<chdir>, to easily get an absolute path out of a relative path for future
		1451	reference, and to speed up doing many operations in the same directory
		1452	(e.g. when stat'ing all files in a directory).
		1453
		1454	The following functions implement this working directory abstraction:
		1455
		1456	=over 4
		1457
		1458	=item aio_wd $pathname, $callback->($wd)
		1459
		1460	Asynchonously canonicalise the given pathname and convert it to an
		1461	IO::AIO::WD object representing it. If possible and supported on the
		1462	system, also open a directory fd to speed up pathname resolution relative
		1463	to this working directory.
		1464
		1465	If something goes wrong, then C<undef> is passwd to the callback instead
		1466	of a working directory object and C<$!> is set appropriately. Since
		1467	passing C<undef> as working directory component of a pathname fails the
		1468	request with C<ENOENT>, there is often no need for error checking in the
		1469	C<aio_wd> callback, as future requests using the value will fail in the
		1470	expected way.
		1471
		1472	If this call isn't available because your OS lacks it or it couldn't be
		1473	detected, it will be emulated by calling C<fsync> instead.
		1474
		1475	=item IO::AIO::CWD
		1476
		1477	This is a compiletime constant (object) that represents the process
		1478	current working directory.
		1479
		1480	Specifying this object as working directory object for a pathname is as
		1481	if the pathname would be specified directly, without a directory object,
		1482	e.g., these calls are functionally identical:
		1483
		1484	aio_stat "somefile", sub { ... };
		1485	aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
		1486
		1487	=back
		1488
593		1489
594	=head2 IO::AIO::REQ CLASS	1490	=head2 IO::AIO::REQ CLASS
595		1491
596	All non-aggregate C<aio_*> functions return an object of this class when	1492	All non-aggregate C<aio_*> functions return an object of this class when
597	called in non-void context.	1493	called in non-void context.
598
599	A request always moves through the following five states in its lifetime,
600	in order: B<ready> (request has been created, but has not been executed
601	yet), B<execute> (request is currently being executed), B<pending>
602	(request has been executed but callback has not been called yet),
603	B<result> (results are being processed synchronously, includes calling the
604	callback) and B<done> (request has reached the end of its lifetime and
605	holds no resources anymore).
606		1494
607	=over 4	1495	=over 4
608		1496
609	=item cancel $req	1497	=item cancel $req
610		1498
611	Cancels the request, if possible. Has the effect of skipping execution	1499	Cancels the request, if possible. Has the effect of skipping execution
612	when entering the B<execute> state and skipping calling the callback when	1500	when entering the B<execute> state and skipping calling the callback when
613	entering the the B<result> state, but will leave the request otherwise	1501	entering the the B<result> state, but will leave the request otherwise
614	untouched. That means that requests that currently execute will not be	1502	untouched (with the exception of readdir). That means that requests that
615	stopped and resources held by the request will not be freed prematurely.	1503	currently execute will not be stopped and resources held by the request
		1504	will not be freed prematurely.
616		1505
617	=item cb $req $callback->(...)	1506	=item cb $req $callback->(...)
618		1507
619	Replace (or simply set) the callback registered to the request.	1508	Replace (or simply set) the callback registered to the request.
620		1509
…		…
664	=item * They can also can also be added to other IO::AIO::GRP objects.	1553	=item * They can also can also be added to other IO::AIO::GRP objects.
665		1554
666	=item * You must not add requests to a group from within the group callback (or	1555	=item * You must not add requests to a group from within the group callback (or
667	any later time).	1556	any later time).
668		1557
669	=item * This does not harmonise well with C<max_outstanding>, so best do
670	not combine C<aio_group> with it. Groups and feeders are recommended for
671	this kind of concurrency-limiting.
672
673	=back	1558	=back
674		1559
675	Their lifetime, simplified, looks like this: when they are empty, they	1560	Their lifetime, simplified, looks like this: when they are empty, they
676	will finish very quickly. If they contain only requests that are in the	1561	will finish very quickly. If they contain only requests that are in the
677	C<done> state, they will also finish. Otherwise they will continue to	1562	C<done> state, they will also finish. Otherwise they will continue to
678	exist.	1563	exist.
679		1564
680	That means after creating a group you have some time to add requests. And	1565	That means after creating a group you have some time to add requests
681	in the callbacks of those requests, you can add further requests to the	1566	(precisely before the callback has been invoked, which is only done within
682	group. And only when all those requests have finished will the the group	1567	the C<poll_cb>). And in the callbacks of those requests, you can add
683	itself finish.	1568	further requests to the group. And only when all those requests have
		1569	finished will the the group itself finish.
684		1570
685	=over 4	1571	=over 4
686		1572
687	=item add $grp ...	1573	=item add $grp ...
688		1574
…		…
692	be added, including other groups, as long as you do not create circular	1578	be added, including other groups, as long as you do not create circular
693	dependencies.	1579	dependencies.
694		1580
695	Returns all its arguments.	1581	Returns all its arguments.
696		1582
		1583	=item $grp->cancel_subs
		1584
		1585	Cancel all subrequests and clears any feeder, but not the group request
		1586	itself. Useful when you queued a lot of events but got a result early.
		1587
		1588	The group request will finish normally (you cannot add requests to the
		1589	group).
		1590
697	=item $grp->result (...)	1591	=item $grp->result (...)
698		1592
699	Set the result value(s) that will be passed to the group callback when all	1593	Set the result value(s) that will be passed to the group callback when all
700	subrequests have finished. By default, no argument will be passed.	1594	subrequests have finished and set the groups errno to the current value
		1595	of errno (just like calling C<errno> without an error number). By default,
		1596	no argument will be passed and errno is zero.
		1597
		1598	=item $grp->errno ([$errno])
		1599
		1600	Sets the group errno value to C<$errno>, or the current value of errno
		1601	when the argument is missing.
		1602
		1603	Every aio request has an associated errno value that is restored when
		1604	the callback is invoked. This method lets you change this value from its
		1605	default (0).
		1606
		1607	Calling C<result> will also set errno, so make sure you either set C<$!>
		1608	before the call to C<result>, or call c<errno> after it.
701		1609
702	=item feed $grp $callback->($grp)	1610	=item feed $grp $callback->($grp)
703
704	[VERY EXPERIMENTAL]
705		1611
706	Sets a feeder/generator on this group: every group can have an attached	1612	Sets a feeder/generator on this group: every group can have an attached
707	generator that generates requests if idle. The idea behind this is that,	1613	generator that generates requests if idle. The idea behind this is that,
708	although you could just queue as many requests as you want in a group,	1614	although you could just queue as many requests as you want in a group,
709	this might starve other requests for a potentially long time. For	1615	this might starve other requests for a potentially long time. For example,
710	example, C<aio_scandir> might generate hundreds of thousands C<aio_stat>	1616	C<aio_scandir> might generate hundreds of thousands of C<aio_stat>
711	requests, delaying any later requests for a long time.	1617	requests, delaying any later requests for a long time.
712		1618
713	To avoid this, and allow incremental generation of requests, you can	1619	To avoid this, and allow incremental generation of requests, you can
714	instead a group and set a feeder on it that generates those requests. The	1620	instead a group and set a feeder on it that generates those requests. The
715	feed callback will be called whenever there are few enough (see C<limit>,	1621	feed callback will be called whenever there are few enough (see C<limit>,
…		…
720	not impose any limits).	1626	not impose any limits).
721		1627
722	If the feed does not queue more requests when called, it will be	1628	If the feed does not queue more requests when called, it will be
723	automatically removed from the group.	1629	automatically removed from the group.
724		1630
725	If the feed limit is C<0>, it will be set to C<2> automatically.	1631	If the feed limit is C<0> when this method is called, it will be set to
		1632	C<2> automatically.
726		1633
727	Example:	1634	Example:
728		1635
729	# stat all files in @files, but only ever use four aio requests concurrently:	1636	# stat all files in @files, but only ever use four aio requests concurrently:
730		1637
…		…
742	Sets the feeder limit for the group: The feeder will be called whenever	1649	Sets the feeder limit for the group: The feeder will be called whenever
743	the group contains less than this many requests.	1650	the group contains less than this many requests.
744		1651
745	Setting the limit to C<0> will pause the feeding process.	1652	Setting the limit to C<0> will pause the feeding process.
746		1653
		1654	The default value for the limit is C<0>, but note that setting a feeder
		1655	automatically bumps it up to C<2>.
		1656
747	=back	1657	=back
748		1658
749	=head2 SUPPORT FUNCTIONS	1659	=head2 SUPPORT FUNCTIONS
750		1660
		1661	=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
		1662
751	=over 4	1663	=over 4
752		1664
753	=item $fileno = IO::AIO::poll_fileno	1665	=item $fileno = IO::AIO::poll_fileno
754		1666
755	Return the I<request result pipe file descriptor>. This filehandle must be	1667	Return the I<request result pipe file descriptor>. This filehandle must be
756	polled for reading by some mechanism outside this module (e.g. Event or	1668	polled for reading by some mechanism outside this module (e.g. EV, Glib,
757	select, see below or the SYNOPSIS). If the pipe becomes readable you have	1669	select and so on, see below or the SYNOPSIS). If the pipe becomes readable
758	to call C<poll_cb> to check the results.	1670	you have to call C<poll_cb> to check the results.
759		1671
760	See C<poll_cb> for an example.	1672	See C<poll_cb> for an example.
761		1673
762	=item IO::AIO::poll_cb	1674	=item IO::AIO::poll_cb
763		1675
764	Process all outstanding events on the result pipe. You have to call this	1676	Process some outstanding events on the result pipe. You have to call
765	regularly. Returns the number of events processed. Returns immediately	1677	this regularly. Returns C<0> if all events could be processed (or there
766	when no events are outstanding.	1678	were no events to process), or C<-1> if it returned earlier for whatever
		1679	reason. Returns immediately when no events are outstanding. The amount of
		1680	events processed depends on the settings of C<IO::AIO::max_poll_req> and
		1681	C<IO::AIO::max_poll_time>.
		1682
		1683	If not all requests were processed for whatever reason, the filehandle
		1684	will still be ready when C<poll_cb> returns, so normally you don't have to
		1685	do anything special to have it called later.
		1686
		1687	Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes
		1688	ready, it can be beneficial to call this function from loops which submit
		1689	a lot of requests, to make sure the results get processed when they become
		1690	available and not just when the loop is finished and the event loop takes
		1691	over again. This function returns very fast when there are no outstanding
		1692	requests.
767		1693
768	Example: Install an Event watcher that automatically calls	1694	Example: Install an Event watcher that automatically calls
769	IO::AIO::poll_cb with high priority:	1695	IO::AIO::poll_cb with high priority (more examples can be found in the
		1696	SYNOPSIS section, at the top of this document):
770		1697
771	Event->io (fd => IO::AIO::poll_fileno,	1698	Event->io (fd => IO::AIO::poll_fileno,
772	poll => 'r', async => 1,	1699	poll => 'r', async => 1,
773	cb => \&IO::AIO::poll_cb);	1700	cb => \&IO::AIO::poll_cb);
774		1701
775	=item IO::AIO::poll_wait	1702	=item IO::AIO::poll_wait
776		1703
		1704	If there are any outstanding requests and none of them in the result
777	Wait till the result filehandle becomes ready for reading (simply does a	1705	phase, wait till the result filehandle becomes ready for reading (simply
778	C<select> on the filehandle. This is useful if you want to synchronously wait	1706	does a C<select> on the filehandle. This is useful if you want to
779	for some requests to finish).	1707	synchronously wait for some requests to finish).
780		1708
781	See C<nreqs> for an example.	1709	See C<nreqs> for an example.
782		1710
		1711	=item IO::AIO::poll
		1712
		1713	Waits until some requests have been handled.
		1714
		1715	Returns the number of requests processed, but is otherwise strictly
		1716	equivalent to:
		1717
		1718	IO::AIO::poll_wait, IO::AIO::poll_cb
		1719
783	=item IO::AIO::nreqs	1720	=item IO::AIO::flush
784		1721
785	Returns the number of requests currently outstanding (i.e. for which their	1722	Wait till all outstanding AIO requests have been handled.
786	callback has not been invoked yet).
787		1723
788	Example: wait till there are no outstanding requests anymore:	1724	Strictly equivalent to:
789		1725
790	IO::AIO::poll_wait, IO::AIO::poll_cb	1726	IO::AIO::poll_wait, IO::AIO::poll_cb
791	while IO::AIO::nreqs;	1727	while IO::AIO::nreqs;
792		1728
793	=item IO::AIO::flush	1729	=item IO::AIO::max_poll_reqs $nreqs
794		1730
795	Wait till all outstanding AIO requests have been handled.	1731	=item IO::AIO::max_poll_time $seconds
796		1732
797	Strictly equivalent to:	1733	These set the maximum number of requests (default C<0>, meaning infinity)
		1734	that are being processed by C<IO::AIO::poll_cb> in one call, respectively
		1735	the maximum amount of time (default C<0>, meaning infinity) spent in
		1736	C<IO::AIO::poll_cb> to process requests (more correctly the mininum amount
		1737	of time C<poll_cb> is allowed to use).
798		1738
799	IO::AIO::poll_wait, IO::AIO::poll_cb	1739	Setting C<max_poll_time> to a non-zero value creates an overhead of one
800	while IO::AIO::nreqs;	1740	syscall per request processed, which is not normally a problem unless your
		1741	callbacks are really really fast or your OS is really really slow (I am
		1742	not mentioning Solaris here). Using C<max_poll_reqs> incurs no overhead.
801		1743
802	=item IO::AIO::poll	1744	Setting these is useful if you want to ensure some level of
		1745	interactiveness when perl is not fast enough to process all requests in
		1746	time.
803		1747
804	Waits until some requests have been handled.	1748	For interactive programs, values such as C<0.01> to C<0.1> should be fine.
805		1749
806	Strictly equivalent to:	1750	Example: Install an Event watcher that automatically calls
		1751	IO::AIO::poll_cb with low priority, to ensure that other parts of the
		1752	program get the CPU sometimes even under high AIO load.
807		1753
808	IO::AIO::poll_wait, IO::AIO::poll_cb	1754	# try not to spend much more than 0.1s in poll_cb
809	if IO::AIO::nreqs;	1755	IO::AIO::max_poll_time 0.1;
		1756
		1757	# use a low priority so other tasks have priority
		1758	Event->io (fd => IO::AIO::poll_fileno,
		1759	poll => 'r', nice => 1,
		1760	cb => &IO::AIO::poll_cb);
		1761
		1762	=back
		1763
		1764	=head3 CONTROLLING THE NUMBER OF THREADS
		1765
		1766	=over
810		1767
811	=item IO::AIO::min_parallel $nthreads	1768	=item IO::AIO::min_parallel $nthreads
812		1769
813	Set the minimum number of AIO threads to C<$nthreads>. The current	1770	Set the minimum number of AIO threads to C<$nthreads>. The current
814	default is C<8>, which means eight asynchronous operations can execute	1771	default is C<8>, which means eight asynchronous operations can execute
815	concurrently at any one time (the number of outstanding requests,	1772	concurrently at any one time (the number of outstanding requests,
816	however, is unlimited).	1773	however, is unlimited).
817		1774
818	IO::AIO starts threads only on demand, when an AIO request is queued and	1775	IO::AIO starts threads only on demand, when an AIO request is queued and
819	no free thread exists.	1776	no free thread exists. Please note that queueing up a hundred requests can
		1777	create demand for a hundred threads, even if it turns out that everything
		1778	is in the cache and could have been processed faster by a single thread.
820		1779
821	It is recommended to keep the number of threads relatively low, as some	1780	It is recommended to keep the number of threads relatively low, as some
822	Linux kernel versions will scale negatively with the number of threads	1781	Linux kernel versions will scale negatively with the number of threads
823	(higher parallelity => MUCH higher latency). With current Linux 2.6	1782	(higher parallelity => MUCH higher latency). With current Linux 2.6
824	versions, 4-32 threads should be fine.	1783	versions, 4-32 threads should be fine.
…		…
838	This module automatically runs C<max_parallel 0> at program end, to ensure	1797	This module automatically runs C<max_parallel 0> at program end, to ensure
839	that all threads are killed and that there are no outstanding requests.	1798	that all threads are killed and that there are no outstanding requests.
840		1799
841	Under normal circumstances you don't need to call this function.	1800	Under normal circumstances you don't need to call this function.
842		1801
		1802	=item IO::AIO::max_idle $nthreads
		1803
		1804	Limit the number of threads (default: 4) that are allowed to idle
		1805	(i.e., threads that did not get a request to process within the idle
		1806	timeout (default: 10 seconds). That means if a thread becomes idle while
		1807	C<$nthreads> other threads are also idle, it will free its resources and
		1808	exit.
		1809
		1810	This is useful when you allow a large number of threads (e.g. 100 or 1000)
		1811	to allow for extremely high load situations, but want to free resources
		1812	under normal circumstances (1000 threads can easily consume 30MB of RAM).
		1813
		1814	The default is probably ok in most situations, especially if thread
		1815	creation is fast. If thread creation is very slow on your system you might
		1816	want to use larger values.
		1817
		1818	=item IO::AIO::idle_timeout $seconds
		1819
		1820	Sets the minimum idle timeout (default 10) after which worker threads are
		1821	allowed to exit. SEe C<IO::AIO::max_idle>.
		1822
843	=item $oldnreqs = IO::AIO::max_outstanding $nreqs	1823	=item IO::AIO::max_outstanding $maxreqs
844		1824
845	[DEPRECATED]
846
847	Sets the maximum number of outstanding requests to C<$nreqs>. If you	1825	Sets the maximum number of outstanding requests to C<$nreqs>. If
848	try to queue up more than this number of requests, the caller will block until	1826	you do queue up more than this number of requests, the next call to
849	some requests have been handled.	1827	C<IO::AIO::poll_cb> (and other functions calling C<poll_cb>, such as
		1828	C<IO::AIO::flush> or C<IO::AIO::poll>) will block until the limit is no
		1829	longer exceeded.
850		1830
851	The default is very large, so normally there is no practical limit. If you	1831	In other words, this setting does not enforce a queue limit, but can be
852	queue up many requests in a loop it often improves speed if you set	1832	used to make poll functions block if the limit is exceeded.
853	this to a relatively low number, such as C<100>.
854		1833
855	This function does not work well together with C<aio_group>'s, and their	1834	This is a very bad function to use in interactive programs because it
856	feeder interface is better suited to limiting concurrency, so do not use	1835	blocks, and a bad way to reduce concurrency because it is inexact: Better
857	this function.	1836	use an C<aio_group> together with a feed callback.
858		1837
859	Under normal circumstances you don't need to call this function.	1838	It's main use is in scripts without an event loop - when you want to stat
		1839	a lot of files, you can write somehting like this:
		1840
		1841	IO::AIO::max_outstanding 32;
		1842
		1843	for my $path (...) {
		1844	aio_stat $path , ...;
		1845	IO::AIO::poll_cb;
		1846	}
		1847
		1848	IO::AIO::flush;
		1849
		1850	The call to C<poll_cb> inside the loop will normally return instantly, but
		1851	as soon as more thna C<32> reqeusts are in-flight, it will block until
		1852	some requests have been handled. This keeps the loop from pushing a large
		1853	number of C<aio_stat> requests onto the queue.
		1854
		1855	The default value for C<max_outstanding> is very large, so there is no
		1856	practical limit on the number of outstanding requests.
860		1857
861	=back	1858	=back
862		1859
		1860	=head3 STATISTICAL INFORMATION
		1861
		1862	=over
		1863
		1864	=item IO::AIO::nreqs
		1865
		1866	Returns the number of requests currently in the ready, execute or pending
		1867	states (i.e. for which their callback has not been invoked yet).
		1868
		1869	Example: wait till there are no outstanding requests anymore:
		1870
		1871	IO::AIO::poll_wait, IO::AIO::poll_cb
		1872	while IO::AIO::nreqs;
		1873
		1874	=item IO::AIO::nready
		1875
		1876	Returns the number of requests currently in the ready state (not yet
		1877	executed).
		1878
		1879	=item IO::AIO::npending
		1880
		1881	Returns the number of requests currently in the pending state (executed,
		1882	but not yet processed by poll_cb).
		1883
		1884	=back
		1885
		1886	=head3 MISCELLANEOUS FUNCTIONS
		1887
		1888	IO::AIO implements some functions that might be useful, but are not
		1889	asynchronous.
		1890
		1891	=over 4
		1892
		1893	=item IO::AIO::sendfile $ofh, $ifh, $offset, $count
		1894
		1895	Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>,
		1896	but is blocking (this makes most sense if you know the input data is
		1897	likely cached already and the output filehandle is set to non-blocking
		1898	operations).
		1899
		1900	Returns the number of bytes copied, or C<-1> on error.
		1901
		1902	=item IO::AIO::fadvise $fh, $offset, $len, $advice
		1903
		1904	Simply calls the C<posix_fadvise> function (see its
		1905	manpage for details). The following advice constants are
		1906	available: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,
		1907	C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>,
		1908	C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.
		1909
		1910	On systems that do not implement C<posix_fadvise>, this function returns
		1911	ENOSYS, otherwise the return value of C<posix_fadvise>.
		1912
		1913	=item IO::AIO::madvise $scalar, $offset, $len, $advice
		1914
		1915	Simply calls the C<posix_madvise> function (see its
		1916	manpage for details). The following advice constants are
		1917	available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
		1918	C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>.
		1919
		1920	On systems that do not implement C<posix_madvise>, this function returns
		1921	ENOSYS, otherwise the return value of C<posix_madvise>.
		1922
		1923	=item IO::AIO::mprotect $scalar, $offset, $len, $protect
		1924
		1925	Simply calls the C<mprotect> function on the preferably AIO::mmap'ed
		1926	$scalar (see its manpage for details). The following protect
		1927	constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,
		1928	C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.
		1929
		1930	On systems that do not implement C<mprotect>, this function returns
		1931	ENOSYS, otherwise the return value of C<mprotect>.
		1932
		1933	=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
		1934
		1935	Memory-maps a file (or anonymous memory range) and attaches it to the
		1936	given C<$scalar>, which will act like a string scalar. Returns true on
		1937	success, and false otherwise.
		1938
		1939	The only operations allowed on the scalar are C<substr>/C<vec> that don't
		1940	change the string length, and most read-only operations such as copying it
		1941	or searching it with regexes and so on.
		1942
		1943	Anything else is unsafe and will, at best, result in memory leaks.
		1944
		1945	The memory map associated with the C<$scalar> is automatically removed
		1946	when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or
		1947	C<IO::AIO::munmap> functions are called.
		1948
		1949	This calls the C<mmap>(2) function internally. See your system's manual
		1950	page for details on the C<$length>, C<$prot> and C<$flags> parameters.
		1951
		1952	The C<$length> must be larger than zero and smaller than the actual
		1953	filesize.
		1954
		1955	C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,
		1956	C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,
		1957
		1958	C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or
		1959	C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when
		1960	not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS>
		1961	(which is set to C<MAP_ANON> if your system only provides this
		1962	constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>,
		1963	C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or
		1964	C<IO::AIO::MAP_NONBLOCK>
		1965
		1966	If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
		1967
		1968	C<$offset> is the offset from the start of the file - it generally must be
		1969	a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.
		1970
		1971	Example:
		1972
		1973	use Digest::MD5;
		1974	use IO::AIO;
		1975
		1976	open my $fh, "<verybigfile"
		1977	or die "$!";
		1978
		1979	IO::AIO::mmap my $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh
		1980	or die "verybigfile: $!";
		1981
		1982	my $fast_md5 = md5 $data;
		1983
		1984	=item IO::AIO::munmap $scalar
		1985
		1986	Removes a previous mmap and undefines the C<$scalar>.
		1987
		1988	=item IO::AIO::munlock $scalar, $offset = 0, $length = undef
		1989
		1990	Calls the C<munlock> function, undoing the effects of a previous
		1991	C<aio_mlock> call (see its description for details).
		1992
		1993	=item IO::AIO::munlockall
		1994
		1995	Calls the C<munlockall> function.
		1996
		1997	On systems that do not implement C<munlockall>, this function returns
		1998	ENOSYS, otherwise the return value of C<munlockall>.
		1999
		2000	=item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
		2001
		2002	Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or
		2003	C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they
		2004	should be the file offset.
		2005
		2006	C<$r_fh> and C<$w_fh> should not refer to the same file, as splice might
		2007	silently corrupt the data in this case.
		2008
		2009	The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>,
		2010	C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and
		2011	C<IO::AIO::SPLICE_F_GIFT>.
		2012
		2013	See the C<splice(2)> manpage for details.
		2014
		2015	=item IO::AIO::tee $r_fh, $w_fh, $length, $flags
		2016
		2017	Calls the GNU/Linux C<tee(2)> syscall, see it's manpage and the
		2018	description for C<IO::AIO::splice> above for details.
		2019
		2020	=back
		2021
863	=cut	2022	=cut
864		2023
865	# support function to convert a fd into a perl filehandle
866	sub _fd2fh {
867	return undef if $_[0] < 0;
868
869	# try to generate nice filehandles
870	my $sym = "IO::AIO::fd#$_[0]";
871	local *$sym;
872
873	open *$sym, "+<&=$_[0]" # usually works under any unix
874	or open *$sym, "<&=$_[0]" # cygwin needs this
875	or open *$sym, ">&=$_[0]" # or this
876	or return undef;
877
878	*$sym
879	}
880
881	min_parallel 8;	2024	min_parallel 8;
882		2025
883	END {	2026	END { flush }
884	max_parallel 0;
885	}
886		2027
887	1;	2028	1;
888		2029
		2030	=head1 EVENT LOOP INTEGRATION
		2031
		2032	It is recommended to use L<AnyEvent::AIO> to integrate IO::AIO
		2033	automatically into many event loops:
		2034
		2035	# AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
		2036	use AnyEvent::AIO;
		2037
		2038	You can also integrate IO::AIO manually into many event loops, here are
		2039	some examples of how to do this:
		2040
		2041	# EV integration
		2042	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
		2043
		2044	# Event integration
		2045	Event->io (fd => IO::AIO::poll_fileno,
		2046	poll => 'r',
		2047	cb => \&IO::AIO::poll_cb);
		2048
		2049	# Glib/Gtk2 integration
		2050	add_watch Glib::IO IO::AIO::poll_fileno,
		2051	in => sub { IO::AIO::poll_cb; 1 };
		2052
		2053	# Tk integration
		2054	Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
		2055	readable => \&IO::AIO::poll_cb);
		2056
		2057	# Danga::Socket integration
		2058	Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
		2059	\&IO::AIO::poll_cb);
		2060
889	=head2 FORK BEHAVIOUR	2061	=head2 FORK BEHAVIOUR
890		2062
891	This module should do "the right thing" when the process using it forks:	2063	Usage of pthreads in a program changes the semantics of fork
		2064	considerably. Specifically, only async-safe functions can be called after
		2065	fork. Perl doesn't know about this, so in general, you cannot call fork
		2066	with defined behaviour in perl if pthreads are involved. IO::AIO uses
		2067	pthreads, so this applies, but many other extensions and (for inexplicable
		2068	reasons) perl itself often is linked against pthreads, so this limitation
		2069	applies to quite a lot of perls.
892		2070
893	Before the fork, IO::AIO enters a quiescent state where no requests	2071	This module no longer tries to fight your OS, or POSIX. That means IO::AIO
894	can be added in other threads and no results will be processed. After	2072	only works in the process that loaded it. Forking is fully supported, but
895	the fork the parent simply leaves the quiescent state and continues	2073	using IO::AIO in the child is not.
896	request/result processing, while the child clears the request/result
897	queue (so the requests started before the fork will only be handled in
898	the parent). Threads will be started on demand until the limit ste in the
899	parent process has been reached again.
900		2074
901	In short: the parent will, after a short pause, continue as if fork had	2075	You might get around by not I<using> IO::AIO before (or after)
902	not been called, while the child will act as if IO::AIO has not been used	2076	forking. You could also try to call the L<IO::AIO::reinit> function in the
903	yet.	2077	child:
		2078
		2079	=over 4
		2080
		2081	=item IO::AIO::reinit
		2082
		2083	Abandons all current requests and I/O threads and simply reinitialises all
		2084	data structures. This is not an operation supported by any standards, but
		2085	happens to work on GNU/Linux and some newer BSD systems.
		2086
		2087	The only reasonable use for this function is to call it after forking, if
		2088	C<IO::AIO> was used in the parent. Calling it while IO::AIO is active in
		2089	the process will result in undefined behaviour. Calling it at any time
		2090	will also result in any undefined (by POSIX) behaviour.
		2091
		2092	=back
904		2093
905	=head2 MEMORY USAGE	2094	=head2 MEMORY USAGE
906		2095
		2096	Per-request usage:
		2097
907	Each aio request uses - depending on your architecture - around 128 bytes	2098	Each aio request uses - depending on your architecture - around 100-200
908	of memory. In addition, stat requests need a stat buffer (possibly a few	2099	bytes of memory. In addition, stat requests need a stat buffer (possibly
909	hundred bytes). Perl scalars and other data passed into aio requests will	2100	a few hundred bytes), readdir requires a result buffer and so on. Perl
910	also be locked.	2101	scalars and other data passed into aio requests will also be locked and
		2102	will consume memory till the request has entered the done state.
911		2103
912	This is now awfully much, so queuing lots of requests is not usually a	2104	This is not awfully much, so queuing lots of requests is not usually a
913	problem.	2105	problem.
914		2106
915	Each thread needs a stack area which is usually around 16k, sometimes much	2107	Per-thread usage:
916	larger, depending on the OS.	2108
		2109	In the execution phase, some aio requests require more memory for
		2110	temporary buffers, and each thread requires a stack and other data
		2111	structures (usually around 16k-128k, depending on the OS).
		2112
		2113	=head1 KNOWN BUGS
		2114
		2115	Known bugs will be fixed in the next release.
917		2116
918	=head1 SEE ALSO	2117	=head1 SEE ALSO
919		2118
920	L<Coro::AIO>.	2119	L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
		2120	more natural syntax.
921		2121
922	=head1 AUTHOR	2122	=head1 AUTHOR
923		2123
924	Marc Lehmann <schmorp@schmorp.de>	2124	Marc Lehmann <schmorp@schmorp.de>
925	http://home.schmorp.de/	2125	http://home.schmorp.de/

Diff Legend

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