ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/IO-AIO/AIO.pm

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

Diff Legend

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