ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/IO-AIO/AIO.pm

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.56 by root, Sun Oct 22 00:53:47 2006 UTC vs.
Revision 1.143 by root, Thu Nov 20 09:01:40 2008 UTC

…		…
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", 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
…		…
18	};	19	};
19		20
20	# version 2+ has request and group objects	21	# version 2+ has request and group objects
21	use IO::AIO 2;	22	use IO::AIO 2;
22		23
		24	aioreq_pri 4; # give next request a very high priority
23	my $req = aio_unlink "/tmp/file", sub { };	25	my $req = aio_unlink "/tmp/file", sub { };
24	$req->cancel; # cancel request if still in queue	26	$req->cancel; # cancel request if still in queue
25		27
26	my $grp = aio_group sub { print "all stats done\n" };	28	my $grp = aio_group sub { print "all stats done\n" };
27	add $grp aio_stat "..." for ...;	29	add $grp aio_stat "..." for ...;
28		30
		31	# AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
		32	use AnyEvent::AIO;
		33
29	# AnyEvent integration	34	# EV integration
30	open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!";	35	my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
31	my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb });
32		36
33	# Event integration	37	# Event integration
34	Event->io (fd => IO::AIO::poll_fileno,	38	Event->io (fd => IO::AIO::poll_fileno,
35	poll => 'r',	39	poll => 'r',
36	cb => \&IO::AIO::poll_cb);	40	cb => \&IO::AIO::poll_cb);
…		…
50	=head1 DESCRIPTION	54	=head1 DESCRIPTION
51		55
52	This module implements asynchronous I/O using whatever means your	56	This module implements asynchronous I/O using whatever means your
53	operating system supports.	57	operating system supports.
54		58
		59	Asynchronous means that operations that can normally block your program
		60	(e.g. reading from disk) will be done asynchronously: the operation
		61	will still block, but you can do something else in the meantime. This
		62	is extremely useful for programs that need to stay interactive even
		63	when doing heavy I/O (GUI programs, high performance network servers
		64	etc.), but can also be used to easily do operations in parallel that are
		65	normally done sequentially, e.g. stat'ing many files, which is much faster
		66	on a RAID volume or over NFS when you do a number of stat operations
		67	concurrently.
		68
		69	While most of this works on all types of file descriptors (for
		70	example sockets), using these functions on file descriptors that
		71	support nonblocking operation (again, sockets, pipes etc.) is very
		72	inefficient. Use an event loop for that (such as the L<Event|Event>
		73	module): IO::AIO will naturally fit into such an event loop itself.
		74
55	Currently, a number of threads are started that execute your read/writes	75	In this version, a number of threads are started that execute your
56	and signal their completion. You don't need thread support in your libc or	76	requests and signal their completion. You don't need thread support
57	perl, and the threads created by this module will not be visible to the	77	in perl, and the threads created by this module will not be visible
58	pthreads library. In the future, this module might make use of the native	78	to perl. In the future, this module might make use of the native aio
59	aio functions available on many operating systems. However, they are often	79	functions available on many operating systems. However, they are often
60	not well-supported (Linux doesn't allow them on normal files currently,	80	not well-supported or restricted (GNU/Linux doesn't allow them on normal
61	for example), and they would only support aio_read and aio_write, so the	81	files currently, for example), and they would only support aio_read and
62	remaining functionality would have to be implemented using threads anyway.	82	aio_write, so the remaining functionality would have to be implemented
		83	using threads anyway.
63		84
64	Although the module will work with in the presence of other threads, it is	85	Although the module will work in the presence of other (Perl-) threads,
65	currently not reentrant, so use appropriate locking yourself, always call	86	it is currently not reentrant in any way, so use appropriate locking
66	C<poll_cb> from within the same thread, or never call C<poll_cb> (or other	87	yourself, always call C<poll_cb> from within the same thread, or never
67	C<aio_> functions) recursively.	88	call C<poll_cb> (or other C<aio_> functions) recursively.
		89
		90	=head2 EXAMPLE
		91
		92	This is a simple example that uses the Event module and loads
		93	F</etc/passwd> asynchronously:
		94
		95	use Fcntl;
		96	use Event;
		97	use IO::AIO;
		98
		99	# register the IO::AIO callback with Event
		100	Event->io (fd => IO::AIO::poll_fileno,
		101	poll => 'r',
		102	cb => \&IO::AIO::poll_cb);
		103
		104	# queue the request to open /etc/passwd
		105	aio_open "/etc/passwd", O_RDONLY, 0, sub {
		106	my $fh = shift
		107	or die "error while opening: $!";
		108
		109	# stat'ing filehandles is generally non-blocking
		110	my $size = -s $fh;
		111
		112	# queue a request to read the file
		113	my $contents;
		114	aio_read $fh, 0, $size, $contents, 0, sub {
		115	$_[0] == $size
		116	or die "short read: $!";
		117
		118	close $fh;
		119
		120	# file contents now in $contents
		121	print $contents;
		122
		123	# exit event loop and program
		124	Event::unloop;
		125	};
		126	};
		127
		128	# possibly queue up other requests, or open GUI windows,
		129	# check for sockets etc. etc.
		130
		131	# process events as long as there are some:
		132	Event::loop;
		133
		134	=head1 REQUEST ANATOMY AND LIFETIME
		135
		136	Every C<aio_*> function creates a request. which is a C data structure not
		137	directly visible to Perl.
		138
		139	If called in non-void context, every request function returns a Perl
		140	object representing the request. In void context, nothing is returned,
		141	which saves a bit of memory.
		142
		143	The perl object is a fairly standard ref-to-hash object. The hash contents
		144	are not used by IO::AIO so you are free to store anything you like in it.
		145
		146	During their existance, aio requests travel through the following states,
		147	in order:
		148
		149	=over 4
		150
		151	=item ready
		152
		153	Immediately after a request is created it is put into the ready state,
		154	waiting for a thread to execute it.
		155
		156	=item execute
		157
		158	A thread has accepted the request for processing and is currently
		159	executing it (e.g. blocking in read).
		160
		161	=item pending
		162
		163	The request has been executed and is waiting for result processing.
		164
		165	While request submission and execution is fully asynchronous, result
		166	processing is not and relies on the perl interpreter calling C<poll_cb>
		167	(or another function with the same effect).
		168
		169	=item result
		170
		171	The request results are processed synchronously by C<poll_cb>.
		172
		173	The C<poll_cb> function will process all outstanding aio requests by
		174	calling their callbacks, freeing memory associated with them and managing
		175	any groups they are contained in.
		176
		177	=item done
		178
		179	Request has reached the end of its lifetime and holds no resources anymore
		180	(except possibly for the Perl object, but its connection to the actual
		181	aio request is severed and calling its methods will either do nothing or
		182	result in a runtime error).
		183
		184	=back
68		185
69	=cut	186	=cut
70		187
71	package IO::AIO;	188	package IO::AIO;
		189
		190	use Carp ();
72		191
73	no warnings;	192	no warnings;
74	use strict 'vars';	193	use strict 'vars';
75		194
76	use base 'Exporter';	195	use base 'Exporter';
77		196
78	BEGIN {	197	BEGIN {
79	our $VERSION = '2.0';	198	our $VERSION = '3.17';
80		199
81	our @EXPORT = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat	200	our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close
82	aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink	201	aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir
83	aio_fsync aio_fdatasync aio_readahead aio_rename aio_link aio_move	202	aio_scandir aio_symlink aio_readlink aio_sync aio_fsync
84	aio_group);	203	aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead
85	our @EXPORT_OK = qw(poll_fileno poll_cb min_parallel max_parallel max_outstanding nreqs);	204	aio_rename aio_link aio_move aio_copy aio_group
		205	aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
		206	aio_chmod aio_utime aio_truncate);
		207
		208	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
		209	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
		210	min_parallel max_parallel max_idle
		211	nreqs nready npending nthreads
		212	max_poll_time max_poll_reqs);
		213
		214	push @AIO_REQ, qw(aio_busy); # not exported
86		215
87	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';	216	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';
88		217
89	require XSLoader;	218	require XSLoader;
90	XSLoader::load ("IO::AIO", $VERSION);	219	XSLoader::load ("IO::AIO", $VERSION);
91	}	220	}
92		221
93	=head1 FUNCTIONS	222	=head1 FUNCTIONS
94		223
95	=head2 AIO FUNCTIONS	224	=head2 AIO REQUEST FUNCTIONS
96		225
97	All the C<aio_*> calls are more or less thin wrappers around the syscall	226	All the C<aio_*> calls are more or less thin wrappers around the syscall
98	with the same name (sans C<aio_>). The arguments are similar or identical,	227	with the same name (sans C<aio_>). The arguments are similar or identical,
99	and they all accept an additional (and optional) C<$callback> argument	228	and they all accept an additional (and optional) C<$callback> argument
100	which must be a code reference. This code reference will get called with	229	which must be a code reference. This code reference will get called with
101	the syscall return code (e.g. most syscalls return C<-1> on error, unlike	230	the syscall return code (e.g. most syscalls return C<-1> on error, unlike
102	perl, which usually delivers "false") as it's sole argument when the given	231	perl, which usually delivers "false") as its sole argument after the given
103	syscall has been executed asynchronously.	232	syscall has been executed asynchronously.
104		233
105	All functions expecting a filehandle keep a copy of the filehandle	234	All functions expecting a filehandle keep a copy of the filehandle
106	internally until the request has finished.	235	internally until the request has finished.
107		236
108	All requests return objects of type L<IO::AIO::REQ> that allow further	237	All functions return request objects of type L<IO::AIO::REQ> that allow
109	manipulation of those requests while they are in-flight.	238	further manipulation of those requests while they are in-flight.
110		239
111	The pathnames you pass to these routines I<must> be absolute and	240	The pathnames you pass to these routines I<must> be absolute and
112	encoded in byte form. The reason for the former is that at the time the	241	encoded as octets. The reason for the former is that at the time the
113	request is being executed, the current working directory could have	242	request is being executed, the current working directory could have
114	changed. Alternatively, you can make sure that you never change the	243	changed. Alternatively, you can make sure that you never change the
115	current working directory.	244	current working directory anywhere in the program and then use relative
		245	paths.
116		246
117	To encode pathnames to byte form, either make sure you either: a)	247	To encode pathnames as octets, either make sure you either: a) always pass
118	always pass in filenames you got from outside (command line, readdir	248	in filenames you got from outside (command line, readdir etc.) without
119	etc.), b) are ASCII or ISO 8859-1, c) use the Encode module and encode	249	tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module and encode
120	your pathnames to the locale (or other) encoding in effect in the user	250	your pathnames to the locale (or other) encoding in effect in the user
121	environment, d) use Glib::filename_from_unicode on unicode filenames or e)	251	environment, d) use Glib::filename_from_unicode on unicode filenames or e)
122	use something else.	252	use something else to ensure your scalar has the correct contents.
		253
		254	This works, btw. independent of the internal UTF-8 bit, which IO::AIO
		255	handles correctly whether it is set or not.
123		256
124	=over 4	257	=over 4
		258
		259	=item $prev_pri = aioreq_pri [$pri]
		260
		261	Returns the priority value that would be used for the next request and, if
		262	C<$pri> is given, sets the priority for the next aio request.
		263
		264	The default priority is C<0>, the minimum and maximum priorities are C<-4>
		265	and C<4>, respectively. Requests with higher priority will be serviced
		266	first.
		267
		268	The priority will be reset to C<0> after each call to one of the C<aio_*>
		269	functions.
		270
		271	Example: open a file with low priority, then read something from it with
		272	higher priority so the read request is serviced before other low priority
		273	open requests (potentially spamming the cache):
		274
		275	aioreq_pri -3;
		276	aio_open ..., sub {
		277	return unless $_[0];
		278
		279	aioreq_pri -2;
		280	aio_read $_[0], ..., sub {
		281	...
		282	};
		283	};
		284
		285
		286	=item aioreq_nice $pri_adjust
		287
		288	Similar to C<aioreq_pri>, but subtracts the given value from the current
		289	priority, so the effect is cumulative.
		290
125		291
126	=item aio_open $pathname, $flags, $mode, $callback->($fh)	292	=item aio_open $pathname, $flags, $mode, $callback->($fh)
127		293
128	Asynchronously open or create a file and call the callback with a newly	294	Asynchronously open or create a file and call the callback with a newly
129	created filehandle for the file.	295	created filehandle for the file.
…		…
135	list. They are the same as used by C<sysopen>.	301	list. They are the same as used by C<sysopen>.
136		302
137	Likewise, C<$mode> specifies the mode of the newly created file, if it	303	Likewise, C<$mode> specifies the mode of the newly created file, if it
138	didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>,	304	didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>,
139	except that it is mandatory (i.e. use C<0> if you don't create new files,	305	except that it is mandatory (i.e. use C<0> if you don't create new files,
140	and C<0666> or C<0777> if you do).	306	and C<0666> or C<0777> if you do). Note that the C<$mode> will be modified
		307	by the umask in effect then the request is being executed, so better never
		308	change the umask.
141		309
142	Example:	310	Example:
143		311
144	aio_open "/etc/passwd", O_RDONLY, 0, sub {	312	aio_open "/etc/passwd", O_RDONLY, 0, sub {
145	if ($_[0]) {	313	if ($_[0]) {
…		…
148	} else {	316	} else {
149	die "open failed: $!\n";	317	die "open failed: $!\n";
150	}	318	}
151	};	319	};
152		320
		321
153	=item aio_close $fh, $callback->($status)	322	=item aio_close $fh, $callback->($status)
154		323
155	Asynchronously close a file and call the callback with the result	324	Asynchronously close a file and call the callback with the result
156	code. I<WARNING:> although accepted, you should not pass in a perl	325	code.
157	filehandle here, as perl will likely close the file descriptor another
158	time when the filehandle is destroyed. Normally, you can safely call perls
159	C<close> or just let filehandles go out of scope.
160		326
161	This is supposed to be a bug in the API, so that might change. It's	327	Unfortunately, you can't do this to perl. Perl I<insists> very strongly on
162	therefore best to avoid this function.	328	closing the file descriptor associated with the filehandle itself.
		329
		330	Therefore, C<aio_close> will not close the filehandle - instead it will
		331	use dup2 to overwrite the file descriptor with the write-end of a pipe
		332	(the pipe fd will be created on demand and will be cached).
		333
		334	Or in other words: the file descriptor will be closed, but it will not be
		335	free for reuse until the perl filehandle is closed.
		336
		337	=cut
163		338
164	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	339	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
165		340
166	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	341	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
167		342
168	Reads or writes C<length> bytes from the specified C<fh> and C<offset>	343	Reads or writes C<$length> bytes from the specified C<$fh> and C<$offset>
169	into the scalar given by C<data> and offset C<dataoffset> and calls the	344	into the scalar given by C<$data> and offset C<$dataoffset> and calls the
170	callback without the actual number of bytes read (or -1 on error, just	345	callback without the actual number of bytes read (or -1 on error, just
171	like the syscall).	346	like the syscall).
172		347
		348	If C<$offset> is undefined, then the current file descriptor offset will
		349	be used (and updated), otherwise the file descriptor offset will not be
		350	changed by these calls.
		351
		352	If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>.
		353
		354	If C<$dataoffset> is less than zero, it will be counted from the end of
		355	C<$data>.
		356
173	The C<$data> scalar I<MUST NOT> be modified in any way while the request	357	The C<$data> scalar I<MUST NOT> be modified in any way while the request
174	is outstanding. Modifying it can result in segfaults or WW3 (if the	358	is outstanding. Modifying it can result in segfaults or World War III (if
175	necessary/optional hardware is installed).	359	the necessary/optional hardware is installed).
176		360
177	Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at	361	Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at
178	offset C<0> within the scalar:	362	offset C<0> within the scalar:
179		363
180	aio_read $fh, 7, 15, $buffer, 0, sub {	364	aio_read $fh, 7, 15, $buffer, 0, sub {
181	$_[0] > 0 or die "read error: $!";	365	$_[0] > 0 or die "read error: $!";
182	print "read $_[0] bytes: <$buffer>\n";	366	print "read $_[0] bytes: <$buffer>\n";
183	};	367	};
184		368
185	=item aio_move $srcpath, $dstpath, $callback->($status)
186
187	Try to move the I<file> (directories not supported as either source or
188	destination) from C<$srcpath> to C<$dstpath> and call the callback with
189	the C<0> (error) or C<-1> ok.
190
191	This is a composite request that tries to rename(2) the file first. If
192	rename files with C<EXDEV>, it creates the destination file with mode 0200
193	and copies the contents of the source file into it using C<aio_sendfile>,
194	followed by restoring atime, mtime, access mode and uid/gid, in that
195	order, and unlinking the C<$srcpath>.
196
197	If an error occurs, the partial destination file will be unlinked, if
198	possible, except when setting atime, mtime, access mode and uid/gid, where
199	errors are being ignored.
200
201	=cut
202
203	sub aio_move($$$) {
204	my ($src, $dst, $cb) = @_;
205
206	my $grp = aio_group;
207
208	add $grp aio_rename $src, $dst, sub {
209	if ($_[0] && $! == EXDEV) {
210	add $grp aio_open $src, O_RDONLY, 0, sub {
211	if (my $src_fh = $_[0]) {
212	my @stat = stat $src_fh;
213
214	add $grp aio_open $dst, O_WRONLY, 0200, sub {
215	if (my $dst_fh = $_[0]) {
216	add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
217	close $src_fh;
218
219	if ($_[0] == $stat[7]) {
220	utime $stat[8], $stat[9], $dst;
221	chmod $stat[2] & 07777, $dst_fh;
222	chown $stat[4], $stat[5], $dst_fh;
223	close $dst_fh;
224
225	add $grp aio_unlink $src, sub {
226	$cb->($_[0]);
227	};
228	} else {
229	my $errno = $!;
230	add $grp aio_unlink $dst, sub {
231	$! = $errno;
232	$cb->(-1);
233	};
234	}
235	};
236	} else {
237	$cb->(-1);
238	}
239	},
240
241	} else {
242	$cb->(-1);
243	}
244	};
245	} else {
246	$cb->($_[0]);
247	}
248	};
249
250	$grp
251	}
252		369
253	=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)	370	=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
254		371
255	Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts	372	Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts
256	reading at byte offset C<$in_offset>, and starts writing at the current	373	reading at byte offset C<$in_offset>, and starts writing at the current
…		…
270	C<$in_fh> than are written, and there is no way to find out how many	387	C<$in_fh> than are written, and there is no way to find out how many
271	bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only	388	bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only
272	provides the number of bytes written to C<$out_fh>. Only if the result	389	provides the number of bytes written to C<$out_fh>. Only if the result
273	value equals C<$length> one can assume that C<$length> bytes have been	390	value equals C<$length> one can assume that C<$length> bytes have been
274	read.	391	read.
		392
275		393
276	=item aio_readahead $fh,$offset,$length, $callback->($retval)	394	=item aio_readahead $fh,$offset,$length, $callback->($retval)
277		395
278	C<aio_readahead> populates the page cache with data from a file so that	396	C<aio_readahead> populates the page cache with data from a file so that
279	subsequent reads from that file will not block on disk I/O. The C<$offset>	397	subsequent reads from that file will not block on disk I/O. The C<$offset>
…		…
285	file. The current file offset of the file is left unchanged.	403	file. The current file offset of the file is left unchanged.
286		404
287	If that syscall doesn't exist (likely if your OS isn't Linux) it will be	405	If that syscall doesn't exist (likely if your OS isn't Linux) it will be
288	emulated by simply reading the data, which would have a similar effect.	406	emulated by simply reading the data, which would have a similar effect.
289		407
		408
290	=item aio_stat $fh_or_path, $callback->($status)	409	=item aio_stat $fh_or_path, $callback->($status)
291		410
292	=item aio_lstat $fh, $callback->($status)	411	=item aio_lstat $fh, $callback->($status)
293		412
294	Works like perl's C<stat> or C<lstat> in void context. The callback will	413	Works like perl's C<stat> or C<lstat> in void context. The callback will
…		…
307	aio_stat "/etc/passwd", sub {	426	aio_stat "/etc/passwd", sub {
308	$_[0] and die "stat failed: $!";	427	$_[0] and die "stat failed: $!";
309	print "size is ", -s _, "\n";	428	print "size is ", -s _, "\n";
310	};	429	};
311		430
		431
		432	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
		433
		434	Works like perl's C<utime> function (including the special case of $atime
		435	and $mtime being undef). Fractional times are supported if the underlying
		436	syscalls support them.
		437
		438	When called with a pathname, uses utimes(2) if available, otherwise
		439	utime(2). If called on a file descriptor, uses futimes(2) if available,
		440	otherwise returns ENOSYS, so this is not portable.
		441
		442	Examples:
		443
		444	# set atime and mtime to current time (basically touch(1)):
		445	aio_utime "path", undef, undef;
		446	# set atime to current time and mtime to beginning of the epoch:
		447	aio_utime "path", time, undef; # undef==0
		448
		449
		450	=item aio_chown $fh_or_path, $uid, $gid, $callback->($status)
		451
		452	Works like perl's C<chown> function, except that C<undef> for either $uid
		453	or $gid is being interpreted as "do not change" (but -1 can also be used).
		454
		455	Examples:
		456
		457	# same as "chown root path" in the shell:
		458	aio_chown "path", 0, -1;
		459	# same as above:
		460	aio_chown "path", 0, undef;
		461
		462
		463	=item aio_truncate $fh_or_path, $offset, $callback->($status)
		464
		465	Works like truncate(2) or ftruncate(2).
		466
		467
		468	=item aio_chmod $fh_or_path, $mode, $callback->($status)
		469
		470	Works like perl's C<chmod> function.
		471
		472
312	=item aio_unlink $pathname, $callback->($status)	473	=item aio_unlink $pathname, $callback->($status)
313		474
314	Asynchronously unlink (delete) a file and call the callback with the	475	Asynchronously unlink (delete) a file and call the callback with the
315	result code.	476	result code.
316		477
		478
		479	=item aio_mknod $path, $mode, $dev, $callback->($status)
		480
		481	[EXPERIMENTAL]
		482
		483	Asynchronously create a device node (or fifo). See mknod(2).
		484
		485	The only (POSIX-) portable way of calling this function is:
		486
		487	aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ...
		488
		489
317	=item aio_link $srcpath, $dstpath, $callback->($status)	490	=item aio_link $srcpath, $dstpath, $callback->($status)
318		491
319	Asynchronously create a new link to the existing object at C<$srcpath> at	492	Asynchronously create a new link to the existing object at C<$srcpath> at
320	the path C<$dstpath> and call the callback with the result code.	493	the path C<$dstpath> and call the callback with the result code.
321		494
		495
322	=item aio_symlink $srcpath, $dstpath, $callback->($status)	496	=item aio_symlink $srcpath, $dstpath, $callback->($status)
323		497
324	Asynchronously create a new symbolic link to the existing object at C<$srcpath> at	498	Asynchronously create a new symbolic link to the existing object at C<$srcpath> at
325	the path C<$dstpath> and call the callback with the result code.	499	the path C<$dstpath> and call the callback with the result code.
326		500
		501
		502	=item aio_readlink $path, $callback->($link)
		503
		504	Asynchronously read the symlink specified by C<$path> and pass it to
		505	the callback. If an error occurs, nothing or undef gets passed to the
		506	callback.
		507
		508
327	=item aio_rename $srcpath, $dstpath, $callback->($status)	509	=item aio_rename $srcpath, $dstpath, $callback->($status)
328		510
329	Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as	511	Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
330	rename(2) and call the callback with the result code.	512	rename(2) and call the callback with the result code.
331		513
		514
		515	=item aio_mkdir $pathname, $mode, $callback->($status)
		516
		517	Asynchronously mkdir (create) a directory and call the callback with
		518	the result code. C<$mode> will be modified by the umask at the time the
		519	request is executed, so do not change your umask.
		520
		521
332	=item aio_rmdir $pathname, $callback->($status)	522	=item aio_rmdir $pathname, $callback->($status)
333		523
334	Asynchronously rmdir (delete) a directory and call the callback with the	524	Asynchronously rmdir (delete) a directory and call the callback with the
335	result code.	525	result code.
		526
336		527
337	=item aio_readdir $pathname, $callback->($entries)	528	=item aio_readdir $pathname, $callback->($entries)
338		529
339	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire	530	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
340	directory (i.e. opendir + readdir + closedir). The entries will not be	531	directory (i.e. opendir + readdir + closedir). The entries will not be
341	sorted, and will B<NOT> include the C<.> and C<..> entries.	532	sorted, and will B<NOT> include the C<.> and C<..> entries.
342		533
343	The callback a single argument which is either C<undef> or an array-ref	534	The callback a single argument which is either C<undef> or an array-ref
344	with the filenames.	535	with the filenames.
345		536
		537
		538	=item aio_load $path, $data, $callback->($status)
		539
		540	This is a composite request that tries to fully load the given file into
		541	memory. Status is the same as with aio_read.
		542
		543	=cut
		544
		545	sub aio_load($$;$) {
		546	my ($path, undef, $cb) = @_;
		547	my $data = \$_[1];
		548
		549	my $pri = aioreq_pri;
		550	my $grp = aio_group $cb;
		551
		552	aioreq_pri $pri;
		553	add $grp aio_open $path, O_RDONLY, 0, sub {
		554	my $fh = shift
		555	or return $grp->result (-1);
		556
		557	aioreq_pri $pri;
		558	add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
		559	$grp->result ($_[0]);
		560	};
		561	};
		562
		563	$grp
		564	}
		565
		566	=item aio_copy $srcpath, $dstpath, $callback->($status)
		567
		568	Try to copy the I<file> (directories not supported as either source or
		569	destination) from C<$srcpath> to C<$dstpath> and call the callback with
		570	the C<0> (error) or C<-1> ok.
		571
		572	This is a composite request that creates the destination file with
		573	mode 0200 and copies the contents of the source file into it using
		574	C<aio_sendfile>, followed by restoring atime, mtime, access mode and
		575	uid/gid, in that order.
		576
		577	If an error occurs, the partial destination file will be unlinked, if
		578	possible, except when setting atime, mtime, access mode and uid/gid, where
		579	errors are being ignored.
		580
		581	=cut
		582
		583	sub aio_copy($$;$) {
		584	my ($src, $dst, $cb) = @_;
		585
		586	my $pri = aioreq_pri;
		587	my $grp = aio_group $cb;
		588
		589	aioreq_pri $pri;
		590	add $grp aio_open $src, O_RDONLY, 0, sub {
		591	if (my $src_fh = $_[0]) {
		592	my @stat = stat $src_fh;
		593
		594	aioreq_pri $pri;
		595	add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
		596	if (my $dst_fh = $_[0]) {
		597	aioreq_pri $pri;
		598	add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
		599	if ($_[0] == $stat[7]) {
		600	$grp->result (0);
		601	close $src_fh;
		602
		603	# those should not normally block. should. should.
		604	utime $stat[8], $stat[9], $dst;
		605	chmod $stat[2] & 07777, $dst_fh;
		606	chown $stat[4], $stat[5], $dst_fh;
		607
		608	aioreq_pri $pri;
		609	add $grp aio_close $dst_fh;
		610	} else {
		611	$grp->result (-1);
		612	close $src_fh;
		613	close $dst_fh;
		614
		615	aioreq $pri;
		616	add $grp aio_unlink $dst;
		617	}
		618	};
		619	} else {
		620	$grp->result (-1);
		621	}
		622	},
		623
		624	} else {
		625	$grp->result (-1);
		626	}
		627	};
		628
		629	$grp
		630	}
		631
		632	=item aio_move $srcpath, $dstpath, $callback->($status)
		633
		634	Try to move the I<file> (directories not supported as either source or
		635	destination) from C<$srcpath> to C<$dstpath> and call the callback with
		636	the C<0> (error) or C<-1> ok.
		637
		638	This is a composite request that tries to rename(2) the file first; if
		639	rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if
		640	that is successful, unlinks the C<$srcpath>.
		641
		642	=cut
		643
		644	sub aio_move($$;$) {
		645	my ($src, $dst, $cb) = @_;
		646
		647	my $pri = aioreq_pri;
		648	my $grp = aio_group $cb;
		649
		650	aioreq_pri $pri;
		651	add $grp aio_rename $src, $dst, sub {
		652	if ($_[0] && $! == EXDEV) {
		653	aioreq_pri $pri;
		654	add $grp aio_copy $src, $dst, sub {
		655	$grp->result ($_[0]);
		656
		657	if (!$_[0]) {
		658	aioreq_pri $pri;
		659	add $grp aio_unlink $src;
		660	}
		661	};
		662	} else {
		663	$grp->result ($_[0]);
		664	}
		665	};
		666
		667	$grp
		668	}
		669
346	=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)	670	=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
347		671
348	Scans a directory (similar to C<aio_readdir>) but additionally tries to	672	Scans a directory (similar to C<aio_readdir>) but additionally tries to
349	separate the entries of directory C<$path> into two sets of names, ones	673	efficiently separate the entries of directory C<$path> into two sets of
350	you can recurse into (directories or links to them), and ones you cannot	674	names, directories you can recurse into (directories), and ones you cannot
351	recurse into (everything else).	675	recurse into (everything else, including symlinks to directories).
352		676
353	C<aio_scandir> is a composite request that consists of many sub	677	C<aio_scandir> is a composite request that creates of many sub requests_
354	requests. C<$maxreq> specifies the maximum number of outstanding aio	678	C<$maxreq> specifies the maximum number of outstanding aio requests that
355	requests that this function generates. If it is C<< <= 0 >>, then a	679	this function generates. If it is C<< <= 0 >>, then a suitable default
356	suitable default will be chosen (currently 8).	680	will be chosen (currently 4).
357		681
358	On error, the callback is called without arguments, otherwise it receives	682	On error, the callback is called without arguments, otherwise it receives
359	two array-refs with path-relative entry names.	683	two array-refs with path-relative entry names.
360		684
361	Example:	685	Example:
…		…
395	as those tend to return 0 or 1 as link counts, which disables the	719	as those tend to return 0 or 1 as link counts, which disables the
396	directory counting heuristic.	720	directory counting heuristic.
397		721
398	=cut	722	=cut
399		723
400	sub aio_scandir($$$) {	724	sub aio_scandir($$;$) {
401	my ($path, $maxreq, $cb) = @_;	725	my ($path, $maxreq, $cb) = @_;
402		726
		727	my $pri = aioreq_pri;
		728
403	my $grp = aio_group;	729	my $grp = aio_group $cb;
404		730
405	$maxreq = 8 if $maxreq <= 0;	731	$maxreq = 4 if $maxreq <= 0;
406		732
407	# stat once	733	# stat once
		734	aioreq_pri $pri;
408	add $grp aio_stat $path, sub {	735	add $grp aio_stat $path, sub {
409	return $cb->() if $_[0];	736	return $grp->result () if $_[0];
410	my $now = time;	737	my $now = time;
411	my $hash1 = join ":", (stat _)[0,1,3,7,9];	738	my $hash1 = join ":", (stat _)[0,1,3,7,9];
412		739
413	# read the directory entries	740	# read the directory entries
		741	aioreq_pri $pri;
414	add $grp aio_readdir $path, sub {	742	add $grp aio_readdir $path, sub {
415	my $entries = shift	743	my $entries = shift
416	or return $cb->();	744	or return $grp->result ();
417		745
418	# stat the dir another time	746	# stat the dir another time
		747	aioreq_pri $pri;
419	add $grp aio_stat $path, sub {	748	add $grp aio_stat $path, sub {
420	my $hash2 = join ":", (stat _)[0,1,3,7,9];	749	my $hash2 = join ":", (stat _)[0,1,3,7,9];
421		750
422	my $ndirs;	751	my $ndirs;
423		752
…		…
426	$ndirs = -1;	755	$ndirs = -1;
427	} else {	756	} else {
428	# if nlink == 2, we are finished	757	# if nlink == 2, we are finished
429	# on non-posix-fs's, we rely on nlink < 2	758	# on non-posix-fs's, we rely on nlink < 2
430	$ndirs = (stat _)[3] - 2	759	$ndirs = (stat _)[3] - 2
431	or return $cb->([], $entries);	760	or return $grp->result ([], $entries);
432	}	761	}
433		762
434	# sort into likely dirs and likely nondirs	763	# sort into likely dirs and likely nondirs
435	# dirs == files without ".", short entries first	764	# dirs == files without ".", short entries first
436	$entries = [map $_->[0],	765	$entries = [map $_->[0],
…		…
438	map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],	767	map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
439	@$entries];	768	@$entries];
440		769
441	my (@dirs, @nondirs);	770	my (@dirs, @nondirs);
442		771
443	my ($statcb, $schedcb);	772	my $statgrp = add $grp aio_group sub {
444	my $nreq = 0;	773	$grp->result (\@dirs, \@nondirs);
		774	};
445		775
446	$schedcb = sub {	776	limit $statgrp $maxreq;
447	if (@$entries) {	777	feed $statgrp sub {
448	if ($nreq < $maxreq) {	778	return unless @$entries;
449	my $ent = pop @$entries;	779	my $entry = pop @$entries;
		780
		781	aioreq_pri $pri;
		782	add $statgrp aio_stat "$path/$entry/.", sub {
		783	if ($_[0] < 0) {
		784	push @nondirs, $entry;
		785	} else {
		786	# need to check for real directory
		787	aioreq_pri $pri;
		788	add $statgrp aio_lstat "$path/$entry", sub {
		789	if (-d _) {
		790	push @dirs, $entry;
		791
		792	unless (--$ndirs) {
		793	push @nondirs, @$entries;
		794	feed $statgrp;
		795	}
		796	} else {
		797	push @nondirs, $entry;
		798	}
450	$nreq++;	799	}
451	add $grp aio_stat "$path/$ent/.", sub { $statcb->($_[0], $ent) };
452	}	800	}
453	} elsif (!$nreq) {
454	# finished
455	undef $statcb;
456	undef $schedcb;
457	$cb->(\@dirs, \@nondirs) if $cb;
458	undef $cb;
459	}	801	};
460	};	802	};
461	$statcb = sub {
462	my ($status, $entry) = @_;
463
464	if ($status < 0) {
465	$nreq--;
466	push @nondirs, $entry;
467	&$schedcb;
468	} else {
469	# need to check for real directory
470	add $grp aio_lstat "$path/$entry", sub {
471	$nreq--;
472
473	if (-d _) {
474	push @dirs, $entry;
475
476	if (!--$ndirs) {
477	push @nondirs, @$entries;
478	$entries = [];
479	}
480	} else {
481	push @nondirs, $entry;
482	}
483
484	&$schedcb;
485	}
486	}
487	};
488
489	&$schedcb while @$entries && $nreq < $maxreq;
490	};	803	};
491	};	804	};
492	};	805	};
493		806
494	$grp	807	$grp
495	}	808	}
496		809
		810	=item aio_rmtree $path, $callback->($status)
		811
		812	Delete a directory tree starting (and including) C<$path>, return the
		813	status of the final C<rmdir> only. This is a composite request that
		814	uses C<aio_scandir> to recurse into and rmdir directories, and unlink
		815	everything else.
		816
		817	=cut
		818
		819	sub aio_rmtree;
		820	sub aio_rmtree($;$) {
		821	my ($path, $cb) = @_;
		822
		823	my $pri = aioreq_pri;
		824	my $grp = aio_group $cb;
		825
		826	aioreq_pri $pri;
		827	add $grp aio_scandir $path, 0, sub {
		828	my ($dirs, $nondirs) = @_;
		829
		830	my $dirgrp = aio_group sub {
		831	add $grp aio_rmdir $path, sub {
		832	$grp->result ($_[0]);
		833	};
		834	};
		835
		836	(aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
		837	(aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
		838
		839	add $grp $dirgrp;
		840	};
		841
		842	$grp
		843	}
		844
		845	=item aio_sync $callback->($status)
		846
		847	Asynchronously call sync and call the callback when finished.
		848
497	=item aio_fsync $fh, $callback->($status)	849	=item aio_fsync $fh, $callback->($status)
498		850
499	Asynchronously call fsync on the given filehandle and call the callback	851	Asynchronously call fsync on the given filehandle and call the callback
500	with the fsync result code.	852	with the fsync result code.
501		853
…		…
505	callback with the fdatasync result code.	857	callback with the fdatasync result code.
506		858
507	If this call isn't available because your OS lacks it or it couldn't be	859	If this call isn't available because your OS lacks it or it couldn't be
508	detected, it will be emulated by calling C<fsync> instead.	860	detected, it will be emulated by calling C<fsync> instead.
509		861
		862	=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
		863
		864	Sync the data portion of the file specified by C<$offset> and C<$length>
		865	to disk (but NOT the metadata), by calling the Linux-specific
		866	sync_file_range call. If sync_file_range is not available or it returns
		867	ENOSYS, then fdatasync or fsync is being substituted.
		868
		869	C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,
		870	C<IO::AIO::SYNC_FILE_RANGE_WRITE> and
		871	C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range
		872	manpage for details.
		873
		874	=item aio_pathsync $path, $callback->($status)
		875
		876	This request tries to open, fsync and close the given path. This is a
		877	composite request intended to sync directories after directory operations
		878	(E.g. rename). This might not work on all operating systems or have any
		879	specific effect, but usually it makes sure that directory changes get
		880	written to disc. It works for anything that can be opened for read-only,
		881	not just directories.
		882
		883	Passes C<0> when everything went ok, and C<-1> on error.
		884
		885	=cut
		886
		887	sub aio_pathsync($;$) {
		888	my ($path, $cb) = @_;
		889
		890	my $pri = aioreq_pri;
		891	my $grp = aio_group $cb;
		892
		893	aioreq_pri $pri;
		894	add $grp aio_open $path, O_RDONLY, 0, sub {
		895	my ($fh) = @_;
		896	if ($fh) {
		897	aioreq_pri $pri;
		898	add $grp aio_fsync $fh, sub {
		899	$grp->result ($_[0]);
		900
		901	aioreq_pri $pri;
		902	add $grp aio_close $fh;
		903	};
		904	} else {
		905	$grp->result (-1);
		906	}
		907	};
		908
		909	$grp
		910	}
		911
510	=item aio_group $callback->()	912	=item aio_group $callback->(...)
511
512	[EXPERIMENTAL]
513		913
514	This is a very special aio request: Instead of doing something, it is a	914	This is a very special aio request: Instead of doing something, it is a
515	container for other aio requests, which is useful if you want to bundle	915	container for other aio requests, which is useful if you want to bundle
516	many requests into a single, composite, request.	916	many requests into a single, composite, request with a definite callback
		917	and the ability to cancel the whole request with its subrequests.
517		918
518	Returns an object of class L<IO::AIO::GRP>. See its documentation below	919	Returns an object of class L<IO::AIO::GRP>. See its documentation below
519	for more info.	920	for more info.
520		921
521	Example:	922	Example:
…		…
527	add $grp	928	add $grp
528	(aio_stat ...),	929	(aio_stat ...),
529	(aio_stat ...),	930	(aio_stat ...),
530	...;	931	...;
531		932
		933	=item aio_nop $callback->()
		934
		935	This is a special request - it does nothing in itself and is only used for
		936	side effects, such as when you want to add a dummy request to a group so
		937	that finishing the requests in the group depends on executing the given
		938	code.
		939
		940	While this request does nothing, it still goes through the execution
		941	phase and still requires a worker thread. Thus, the callback will not
		942	be executed immediately but only after other requests in the queue have
		943	entered their execution phase. This can be used to measure request
		944	latency.
		945
532	=item IO::AIO::aio_sleep $fractional_seconds, $callback->() *NOT EXPORTED*	946	=item IO::AIO::aio_busy $fractional_seconds, $callback->() *NOT EXPORTED*
533		947
534	Mainly used for debugging and benchmarking, this aio request puts one of	948	Mainly used for debugging and benchmarking, this aio request puts one of
535	the request workers to sleep for the given time.	949	the request workers to sleep for the given time.
536		950
537	While it is theoretically handy to have simple I/O scheduling requests	951	While it is theoretically handy to have simple I/O scheduling requests
538	like sleep and file handle readable/writable, the overhead this creates	952	like sleep and file handle readable/writable, the overhead this creates is
539	is immense, so do not use this function except to put your application	953	immense (it blocks a thread for a long time) so do not use this function
540	under artificial I/O pressure.	954	except to put your application under artificial I/O pressure.
541		955
542	=back	956	=back
543		957
544	=head2 IO::AIO::REQ CLASS	958	=head2 IO::AIO::REQ CLASS
545		959
546	All non-aggregate C<aio_*> functions return an object of this class when	960	All non-aggregate C<aio_*> functions return an object of this class when
547	called in non-void context.	961	called in non-void context.
548		962
549	A request always moves through the following five states in its lifetime,
550	in order: B<ready> (request has been created, but has not been executed
551	yet), B<execute> (request is currently being executed), B<pending>
552	(request has been executed but callback has not been called yet),
553	B<result> (results are being processed synchronously, includes calling the
554	callback) and B<done> (request has reached the end of its lifetime and
555	holds no resources anymore).
556
557	=over 4	963	=over 4
558		964
559	=item $req->cancel	965	=item cancel $req
560		966
561	Cancels the request, if possible. Has the effect of skipping execution	967	Cancels the request, if possible. Has the effect of skipping execution
562	when entering the B<execute> state and skipping calling the callback when	968	when entering the B<execute> state and skipping calling the callback when
563	entering the the B<result> state, but will leave the request otherwise	969	entering the the B<result> state, but will leave the request otherwise
564	untouched. That means that requests that currently execute will not be	970	untouched. That means that requests that currently execute will not be
565	stopped and resources held by the request will not be freed prematurely.	971	stopped and resources held by the request will not be freed prematurely.
566		972
		973	=item cb $req $callback->(...)
		974
		975	Replace (or simply set) the callback registered to the request.
		976
567	=back	977	=back
568		978
569	=head2 IO::AIO::GRP CLASS	979	=head2 IO::AIO::GRP CLASS
570		980
571	This class is a subclass of L<IO::AIO::REQ>, so all its methods apply to	981	This class is a subclass of L<IO::AIO::REQ>, so all its methods apply to
…		…
585	You add requests by calling the C<add> method with one or more	995	You add requests by calling the C<add> method with one or more
586	C<IO::AIO::REQ> objects:	996	C<IO::AIO::REQ> objects:
587		997
588	$grp->add (aio_unlink "...");	998	$grp->add (aio_unlink "...");
589		999
590	add $grp aio_stat "...", sub { ... };	1000	add $grp aio_stat "...", sub {
		1001	$_[0] or return $grp->result ("error");
		1002
		1003	# add another request dynamically, if first succeeded
		1004	add $grp aio_open "...", sub {
		1005	$grp->result ("ok");
		1006	};
		1007	};
591		1008
592	This makes it very easy to create composite requests (see the source of	1009	This makes it very easy to create composite requests (see the source of
593	C<aio_move> for an application) that work and feel like simple requests.	1010	C<aio_move> for an application) that work and feel like simple requests.
594		1011
		1012	=over 4
		1013
595	The IO::AIO::GRP objects will be cleaned up during calls to	1014	=item * The IO::AIO::GRP objects will be cleaned up during calls to
596	C<IO::AIO::poll_cb>, just like any other request.	1015	C<IO::AIO::poll_cb>, just like any other request.
597		1016
598	They can be canceled like any other request. Canceling will cancel not	1017	=item * They can be canceled like any other request. Canceling will cancel not
599	just the request itself, but also all requests it contains.	1018	only the request itself, but also all requests it contains.
600		1019
601	They can also can also be added to other IO::AIO::GRP objects.	1020	=item * They can also can also be added to other IO::AIO::GRP objects.
		1021
		1022	=item * You must not add requests to a group from within the group callback (or
		1023	any later time).
		1024
		1025	=back
602		1026
603	Their lifetime, simplified, looks like this: when they are empty, they	1027	Their lifetime, simplified, looks like this: when they are empty, they
604	will finish very quickly. If they contain only requests that are in the	1028	will finish very quickly. If they contain only requests that are in the
605	C<done> state, they will also finish. Otherwise they will continue to	1029	C<done> state, they will also finish. Otherwise they will continue to
606	exist.	1030	exist.
607		1031
		1032	That means after creating a group you have some time to add requests
		1033	(precisely before the callback has been invoked, which is only done within
		1034	the C<poll_cb>). And in the callbacks of those requests, you can add
		1035	further requests to the group. And only when all those requests have
		1036	finished will the the group itself finish.
		1037
608	=over 4	1038	=over 4
609		1039
		1040	=item add $grp ...
		1041
610	=item $grp->add (...)	1042	=item $grp->add (...)
611		1043
612	=item add $grp ...	1044	Add one or more requests to the group. Any type of L<IO::AIO::REQ> can
		1045	be added, including other groups, as long as you do not create circular
		1046	dependencies.
613		1047
614	Add one or more	1048	Returns all its arguments.
615	Cancels the request, if possible. Has the effect of skipping execution	1049
616	when entering the B<execute> state and skipping calling the callback when	1050	=item $grp->cancel_subs
617	entering the the B<result> state, but will leave the request otherwise	1051
618	untouched. That means that requests that currently execute will not be	1052	Cancel all subrequests and clears any feeder, but not the group request
619	stopped and resources held by the request will not be freed prematurely.	1053	itself. Useful when you queued a lot of events but got a result early.
		1054
		1055	=item $grp->result (...)
		1056
		1057	Set the result value(s) that will be passed to the group callback when all
		1058	subrequests have finished and set the groups errno to the current value
		1059	of errno (just like calling C<errno> without an error number). By default,
		1060	no argument will be passed and errno is zero.
		1061
		1062	=item $grp->errno ([$errno])
		1063
		1064	Sets the group errno value to C<$errno>, or the current value of errno
		1065	when the argument is missing.
		1066
		1067	Every aio request has an associated errno value that is restored when
		1068	the callback is invoked. This method lets you change this value from its
		1069	default (0).
		1070
		1071	Calling C<result> will also set errno, so make sure you either set C<$!>
		1072	before the call to C<result>, or call c<errno> after it.
		1073
		1074	=item feed $grp $callback->($grp)
		1075
		1076	Sets a feeder/generator on this group: every group can have an attached
		1077	generator that generates requests if idle. The idea behind this is that,
		1078	although you could just queue as many requests as you want in a group,
		1079	this might starve other requests for a potentially long time. For example,
		1080	C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests,
		1081	delaying any later requests for a long time.
		1082
		1083	To avoid this, and allow incremental generation of requests, you can
		1084	instead a group and set a feeder on it that generates those requests. The
		1085	feed callback will be called whenever there are few enough (see C<limit>,
		1086	below) requests active in the group itself and is expected to queue more
		1087	requests.
		1088
		1089	The feed callback can queue as many requests as it likes (i.e. C<add> does
		1090	not impose any limits).
		1091
		1092	If the feed does not queue more requests when called, it will be
		1093	automatically removed from the group.
		1094
		1095	If the feed limit is C<0> when this method is called, it will be set to
		1096	C<2> automatically.
		1097
		1098	Example:
		1099
		1100	# stat all files in @files, but only ever use four aio requests concurrently:
		1101
		1102	my $grp = aio_group sub { print "finished\n" };
		1103	limit $grp 4;
		1104	feed $grp sub {
		1105	my $file = pop @files
		1106	or return;
		1107
		1108	add $grp aio_stat $file, sub { ... };
		1109	};
		1110
		1111	=item limit $grp $num
		1112
		1113	Sets the feeder limit for the group: The feeder will be called whenever
		1114	the group contains less than this many requests.
		1115
		1116	Setting the limit to C<0> will pause the feeding process.
		1117
		1118	The default value for the limit is C<0>, but note that setting a feeder
		1119	automatically bumps it up to C<2>.
620		1120
621	=back	1121	=back
622		1122
623	=head2 SUPPORT FUNCTIONS	1123	=head2 SUPPORT FUNCTIONS
		1124
		1125	=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
624		1126
625	=over 4	1127	=over 4
626		1128
627	=item $fileno = IO::AIO::poll_fileno	1129	=item $fileno = IO::AIO::poll_fileno
628		1130
…		…
633		1135
634	See C<poll_cb> for an example.	1136	See C<poll_cb> for an example.
635		1137
636	=item IO::AIO::poll_cb	1138	=item IO::AIO::poll_cb
637		1139
638	Process all outstanding events on the result pipe. You have to call this	1140	Process some outstanding events on the result pipe. You have to call this
639	regularly. Returns the number of events processed. Returns immediately	1141	regularly. Returns C<0> if all events could be processed, or C<-1> if it
640	when no events are outstanding.	1142	returned earlier for whatever reason. Returns immediately when no events
		1143	are outstanding. The amount of events processed depends on the settings of
		1144	C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.
		1145
		1146	If not all requests were processed for whatever reason, the filehandle
		1147	will still be ready when C<poll_cb> returns, so normally you don't have to
		1148	do anything special to have it called later.
641		1149
642	Example: Install an Event watcher that automatically calls	1150	Example: Install an Event watcher that automatically calls
643	IO::AIO::poll_cb with high priority:	1151	IO::AIO::poll_cb with high priority:
644		1152
645	Event->io (fd => IO::AIO::poll_fileno,	1153	Event->io (fd => IO::AIO::poll_fileno,
646	poll => 'r', async => 1,	1154	poll => 'r', async => 1,
647	cb => \&IO::AIO::poll_cb);	1155	cb => \&IO::AIO::poll_cb);
648		1156
		1157	=item IO::AIO::max_poll_reqs $nreqs
		1158
		1159	=item IO::AIO::max_poll_time $seconds
		1160
		1161	These set the maximum number of requests (default C<0>, meaning infinity)
		1162	that are being processed by C<IO::AIO::poll_cb> in one call, respectively
		1163	the maximum amount of time (default C<0>, meaning infinity) spent in
		1164	C<IO::AIO::poll_cb> to process requests (more correctly the mininum amount
		1165	of time C<poll_cb> is allowed to use).
		1166
		1167	Setting C<max_poll_time> to a non-zero value creates an overhead of one
		1168	syscall per request processed, which is not normally a problem unless your
		1169	callbacks are really really fast or your OS is really really slow (I am
		1170	not mentioning Solaris here). Using C<max_poll_reqs> incurs no overhead.
		1171
		1172	Setting these is useful if you want to ensure some level of
		1173	interactiveness when perl is not fast enough to process all requests in
		1174	time.
		1175
		1176	For interactive programs, values such as C<0.01> to C<0.1> should be fine.
		1177
		1178	Example: Install an Event watcher that automatically calls
		1179	IO::AIO::poll_cb with low priority, to ensure that other parts of the
		1180	program get the CPU sometimes even under high AIO load.
		1181
		1182	# try not to spend much more than 0.1s in poll_cb
		1183	IO::AIO::max_poll_time 0.1;
		1184
		1185	# use a low priority so other tasks have priority
		1186	Event->io (fd => IO::AIO::poll_fileno,
		1187	poll => 'r', nice => 1,
		1188	cb => &IO::AIO::poll_cb);
		1189
649	=item IO::AIO::poll_wait	1190	=item IO::AIO::poll_wait
650		1191
		1192	If there are any outstanding requests and none of them in the result
651	Wait till the result filehandle becomes ready for reading (simply does a	1193	phase, wait till the result filehandle becomes ready for reading (simply
652	C<select> on the filehandle. This is useful if you want to synchronously wait	1194	does a C<select> on the filehandle. This is useful if you want to
653	for some requests to finish).	1195	synchronously wait for some requests to finish).
654		1196
655	See C<nreqs> for an example.	1197	See C<nreqs> for an example.
656		1198
		1199	=item IO::AIO::poll
		1200
		1201	Waits until some requests have been handled.
		1202
		1203	Returns the number of requests processed, but is otherwise strictly
		1204	equivalent to:
		1205
		1206	IO::AIO::poll_wait, IO::AIO::poll_cb
		1207
657	=item IO::AIO::nreqs	1208	=item IO::AIO::flush
658		1209
659	Returns the number of requests currently outstanding (i.e. for which their	1210	Wait till all outstanding AIO requests have been handled.
660	callback has not been invoked yet).
661		1211
662	Example: wait till there are no outstanding requests anymore:	1212	Strictly equivalent to:
663		1213
664	IO::AIO::poll_wait, IO::AIO::poll_cb	1214	IO::AIO::poll_wait, IO::AIO::poll_cb
665	while IO::AIO::nreqs;	1215	while IO::AIO::nreqs;
666		1216
667	=item IO::AIO::flush	1217	=back
668		1218
669	Wait till all outstanding AIO requests have been handled.	1219	=head3 CONTROLLING THE NUMBER OF THREADS
670		1220
671	Strictly equivalent to:	1221	=over
672
673	IO::AIO::poll_wait, IO::AIO::poll_cb
674	while IO::AIO::nreqs;
675
676	=item IO::AIO::poll
677
678	Waits until some requests have been handled.
679
680	Strictly equivalent to:
681
682	IO::AIO::poll_wait, IO::AIO::poll_cb
683	if IO::AIO::nreqs;
684		1222
685	=item IO::AIO::min_parallel $nthreads	1223	=item IO::AIO::min_parallel $nthreads
686		1224
687	Set the minimum number of AIO threads to C<$nthreads>. The current default	1225	Set the minimum number of AIO threads to C<$nthreads>. The current
688	is C<4>, which means four asynchronous operations can be done at one time	1226	default is C<8>, which means eight asynchronous operations can execute
689	(the number of outstanding operations, however, is unlimited).	1227	concurrently at any one time (the number of outstanding requests,
		1228	however, is unlimited).
690		1229
691	IO::AIO starts threads only on demand, when an AIO request is queued and	1230	IO::AIO starts threads only on demand, when an AIO request is queued and
692	no free thread exists.	1231	no free thread exists. Please note that queueing up a hundred requests can
		1232	create demand for a hundred threads, even if it turns out that everything
		1233	is in the cache and could have been processed faster by a single thread.
693		1234
694	It is recommended to keep the number of threads low, as some Linux	1235	It is recommended to keep the number of threads relatively low, as some
695	kernel versions will scale negatively with the number of threads (higher	1236	Linux kernel versions will scale negatively with the number of threads
696	parallelity => MUCH higher latency). With current Linux 2.6 versions, 4-32	1237	(higher parallelity => MUCH higher latency). With current Linux 2.6
697	threads should be fine.	1238	versions, 4-32 threads should be fine.
698		1239
699	Under most circumstances you don't need to call this function, as the	1240	Under most circumstances you don't need to call this function, as the
700	module selects a default that is suitable for low to moderate load.	1241	module selects a default that is suitable for low to moderate load.
701		1242
702	=item IO::AIO::max_parallel $nthreads	1243	=item IO::AIO::max_parallel $nthreads
…		…
711	This module automatically runs C<max_parallel 0> at program end, to ensure	1252	This module automatically runs C<max_parallel 0> at program end, to ensure
712	that all threads are killed and that there are no outstanding requests.	1253	that all threads are killed and that there are no outstanding requests.
713		1254
714	Under normal circumstances you don't need to call this function.	1255	Under normal circumstances you don't need to call this function.
715		1256
		1257	=item IO::AIO::max_idle $nthreads
		1258
		1259	Limit the number of threads (default: 4) that are allowed to idle (i.e.,
		1260	threads that did not get a request to process within 10 seconds). That
		1261	means if a thread becomes idle while C<$nthreads> other threads are also
		1262	idle, it will free its resources and exit.
		1263
		1264	This is useful when you allow a large number of threads (e.g. 100 or 1000)
		1265	to allow for extremely high load situations, but want to free resources
		1266	under normal circumstances (1000 threads can easily consume 30MB of RAM).
		1267
		1268	The default is probably ok in most situations, especially if thread
		1269	creation is fast. If thread creation is very slow on your system you might
		1270	want to use larger values.
		1271
716	=item $oldnreqs = IO::AIO::max_outstanding $nreqs	1272	=item IO::AIO::max_outstanding $maxreqs
		1273
		1274	This is a very bad function to use in interactive programs because it
		1275	blocks, and a bad way to reduce concurrency because it is inexact: Better
		1276	use an C<aio_group> together with a feed callback.
717		1277
718	Sets the maximum number of outstanding requests to C<$nreqs>. If you	1278	Sets the maximum number of outstanding requests to C<$nreqs>. If you
719	try to queue up more than this number of requests, the caller will block until	1279	do queue up more than this number of requests, the next call to the
720	some requests have been handled.	1280	C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)
		1281	function will block until the limit is no longer exceeded.
721		1282
722	The default is very large, so normally there is no practical limit. If you	1283	The default value is very large, so there is no practical limit on the
723	queue up many requests in a loop it often improves speed if you set	1284	number of outstanding requests.
724	this to a relatively low number, such as C<100>.
725		1285
726	Under normal circumstances you don't need to call this function.	1286	You can still queue as many requests as you want. Therefore,
		1287	C<max_outstanding> is mainly useful in simple scripts (with low values) or
		1288	as a stop gap to shield against fatal memory overflow (with large values).
727		1289
728	=back	1290	=back
729		1291
		1292	=head3 STATISTICAL INFORMATION
		1293
		1294	=over
		1295
		1296	=item IO::AIO::nreqs
		1297
		1298	Returns the number of requests currently in the ready, execute or pending
		1299	states (i.e. for which their callback has not been invoked yet).
		1300
		1301	Example: wait till there are no outstanding requests anymore:
		1302
		1303	IO::AIO::poll_wait, IO::AIO::poll_cb
		1304	while IO::AIO::nreqs;
		1305
		1306	=item IO::AIO::nready
		1307
		1308	Returns the number of requests currently in the ready state (not yet
		1309	executed).
		1310
		1311	=item IO::AIO::npending
		1312
		1313	Returns the number of requests currently in the pending state (executed,
		1314	but not yet processed by poll_cb).
		1315
		1316	=back
		1317
730	=cut	1318	=cut
731		1319
732	# support function to convert a fd into a perl filehandle
733	sub _fd2fh {
734	return undef if $_[0] < 0;
735
736	# try to generate nice filehandles
737	my $sym = "IO::AIO::fd#$_[0]";
738	local *$sym;
739
740	open *$sym, "+<&=$_[0]" # usually works under any unix
741	or open *$sym, "<&=$_[0]" # cygwin needs this
742	or open *$sym, ">&=$_[0]" # or this
743	or return undef;
744
745	*$sym
746	}
747
748	min_parallel 4;	1320	min_parallel 8;
749		1321
750	END {	1322	END { flush }
751	max_parallel 0;
752	}
753		1323
754	1;	1324	1;
755		1325
756	=head2 FORK BEHAVIOUR	1326	=head2 FORK BEHAVIOUR
757		1327
758	This module should do "the right thing" when the process using it forks:	1328	This module should do "the right thing" when the process using it forks:
759		1329
760	Before the fork, IO::AIO enters a quiescent state where no requests	1330	Before the fork, IO::AIO enters a quiescent state where no requests
761	can be added in other threads and no results will be processed. After	1331	can be added in other threads and no results will be processed. After
762	the fork the parent simply leaves the quiescent state and continues	1332	the fork the parent simply leaves the quiescent state and continues
763	request/result processing, while the child clears the request/result	1333	request/result processing, while the child frees the request/result queue
764	queue (so the requests started before the fork will only be handled in	1334	(so that the requests started before the fork will only be handled in the
765	the parent). Threads will be started on demand until the limit ste in the	1335	parent). Threads will be started on demand until the limit set in the
766	parent process has been reached again.	1336	parent process has been reached again.
767		1337
768	In short: the parent will, after a short pause, continue as if fork had	1338	In short: the parent will, after a short pause, continue as if fork had
769	not been called, while the child will act as if IO::AIO has not been used	1339	not been called, while the child will act as if IO::AIO has not been used
770	yet.	1340	yet.
771		1341
		1342	=head2 MEMORY USAGE
		1343
		1344	Per-request usage:
		1345
		1346	Each aio request uses - depending on your architecture - around 100-200
		1347	bytes of memory. In addition, stat requests need a stat buffer (possibly
		1348	a few hundred bytes), readdir requires a result buffer and so on. Perl
		1349	scalars and other data passed into aio requests will also be locked and
		1350	will consume memory till the request has entered the done state.
		1351
		1352	This is not awfully much, so queuing lots of requests is not usually a
		1353	problem.
		1354
		1355	Per-thread usage:
		1356
		1357	In the execution phase, some aio requests require more memory for
		1358	temporary buffers, and each thread requires a stack and other data
		1359	structures (usually around 16k-128k, depending on the OS).
		1360
		1361	=head1 KNOWN BUGS
		1362
		1363	Known bugs will be fixed in the next release.
		1364
772	=head1 SEE ALSO	1365	=head1 SEE ALSO
773		1366
774	L<Coro>, L<Linux::AIO> (obsolete).	1367	L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
		1368	more natural syntax.
775		1369
776	=head1 AUTHOR	1370	=head1 AUTHOR
777		1371
778	Marc Lehmann <schmorp@schmorp.de>	1372	Marc Lehmann <schmorp@schmorp.de>
779	http://home.schmorp.de/	1373	http://home.schmorp.de/

Diff Legend

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