[ViewVC] Diff of: cvs/IO-AIO/AIO.pm

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.41 by root, Wed Sep 7 17:41:17 2005 UTC vs.
Revision 1.54 by root, Sun Oct 22 00:19:05 2006 UTC

…		…
14	aio_unlink "/tmp/file", sub { };	14	aio_unlink "/tmp/file", sub { };
15		15
16	aio_read $fh, 30000, 1024, $buffer, 0, sub {	16	aio_read $fh, 30000, 1024, $buffer, 0, sub {
17	$_[0] > 0 or die "read error: $!";	17	$_[0] > 0 or die "read error: $!";
18	};	18	};
		19
		20	use IO::AIO 2; # version has aio objects
		21
		22	my $req = aio_unlink "/tmp/file", sub { };
		23	$req->cancel; # cancel request if still in queue
		24
		25	# AnyEvent
		26	open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!";
		27	my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb });
19		28
20	# Event	29	# Event
21	Event->io (fd => IO::AIO::poll_fileno,	30	Event->io (fd => IO::AIO::poll_fileno,
22	poll => 'r',	31	poll => 'r',
23	cb => \&IO::AIO::poll_cb);	32	cb => \&IO::AIO::poll_cb);
…		…
57	=cut	66	=cut
58		67
59	package IO::AIO;	68	package IO::AIO;
60		69
61	no warnings;	70	no warnings;
		71	use strict 'vars';
62		72
63	use base 'Exporter';	73	use base 'Exporter';
64		74
65	use Fcntl ();
66
67	BEGIN {	75	BEGIN {
68	$VERSION = '1.61';	76	our $VERSION = '1.99';
69		77
70	@EXPORT = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat	78	our @EXPORT = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat
71	aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink	79	aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink
72	aio_fsync aio_fdatasync aio_readahead);	80	aio_fsync aio_fdatasync aio_readahead aio_rename aio_link aio_move
		81	aio_group);
73	@EXPORT_OK = qw(poll_fileno poll_cb min_parallel max_parallel	82	our @EXPORT_OK = qw(poll_fileno poll_cb min_parallel max_parallel max_outstanding nreqs);
74	max_outstanding nreqs);	83
		84	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';
75		85
76	require XSLoader;	86	require XSLoader;
77	XSLoader::load IO::AIO, $VERSION;	87	XSLoader::load ("IO::AIO", $VERSION);
78	}	88	}
79		89
80	=head1 FUNCTIONS	90	=head1 FUNCTIONS
81		91
82	=head2 AIO FUNCTIONS	92	=head2 AIO FUNCTIONS
…		…
89	perl, which usually delivers "false") as it's sole argument when the given	99	perl, which usually delivers "false") as it's sole argument when the given
90	syscall has been executed asynchronously.	100	syscall has been executed asynchronously.
91		101
92	All functions expecting a filehandle keep a copy of the filehandle	102	All functions expecting a filehandle keep a copy of the filehandle
93	internally until the request has finished.	103	internally until the request has finished.
		104
		105	All non-composite requests (requests that are not broken down into
		106	multiple requests) return objects of type L<IO::AIO::REQ> that allow
		107	further manipulation of running requests.
94		108
95	The pathnames you pass to these routines I<must> be absolute and	109	The pathnames you pass to these routines I<must> be absolute and
96	encoded in byte form. The reason for the former is that at the time the	110	encoded in byte form. The reason for the former is that at the time the
97	request is being executed, the current working directory could have	111	request is being executed, the current working directory could have
98	changed. Alternatively, you can make sure that you never change the	112	changed. Alternatively, you can make sure that you never change the
…		…
164	aio_read $fh, 7, 15, $buffer, 0, sub {	178	aio_read $fh, 7, 15, $buffer, 0, sub {
165	$_[0] > 0 or die "read error: $!";	179	$_[0] > 0 or die "read error: $!";
166	print "read $_[0] bytes: <$buffer>\n";	180	print "read $_[0] bytes: <$buffer>\n";
167	};	181	};
168		182
		183	=item aio_move $srcpath, $dstpath, $callback->($status)
		184
		185	Try to move the I<file> (directories not supported as either source or
		186	destination) from C<$srcpath> to C<$dstpath> and call the callback with
		187	the C<0> (error) or C<-1> ok.
		188
		189	This is a composite request that tries to rename(2) the file first. If
		190	rename files with C<EXDEV>, it creates the destination file with mode 0200
		191	and copies the contents of the source file into it using C<aio_sendfile>,
		192	followed by restoring atime, mtime, access mode and uid/gid, in that
		193	order, and unlinking the C<$srcpath>.
		194
		195	If an error occurs, the partial destination file will be unlinked, if
		196	possible, except when setting atime, mtime, access mode and uid/gid, where
		197	errors are being ignored.
		198
		199	=cut
		200
		201	sub aio_move($$$) {
		202	my ($src, $dst, $cb) = @_;
		203
		204	aio_rename $src, $dst, sub {
		205	if ($_[0] && $! == EXDEV) {
		206	aio_open $src, O_RDONLY, 0, sub {
		207	if (my $src_fh = $_[0]) {
		208	my @stat = stat $src_fh;
		209
		210	aio_open $dst, O_WRONLY, 0200, sub {
		211	if (my $dst_fh = $_[0]) {
		212	aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
		213	close $src_fh;
		214
		215	if ($_[0] == $stat[7]) {
		216	utime $stat[8], $stat[9], $dst;
		217	chmod $stat[2] & 07777, $dst_fh;
		218	chown $stat[4], $stat[5], $dst_fh;
		219	close $dst_fh;
		220
		221	aio_unlink $src, sub {
		222	$cb->($_[0]);
		223	};
		224	} else {
		225	my $errno = $!;
		226	aio_unlink $dst, sub {
		227	$! = $errno;
		228	$cb->(-1);
		229	};
		230	}
		231	};
		232	} else {
		233	$cb->(-1);
		234	}
		235	},
		236
		237	} else {
		238	$cb->(-1);
		239	}
		240	};
		241	} else {
		242	$cb->($_[0]);
		243	}
		244	};
		245	}
		246
169	=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)	247	=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
170		248
171	Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts	249	Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts
172	reading at byte offset C<$in_offset>, and starts writing at the current	250	reading at byte offset C<$in_offset>, and starts writing at the current
173	file offset of C<$out_fh>. Because of that, it is not safe to issue more	251	file offset of C<$out_fh>. Because of that, it is not safe to issue more
…		…
228	=item aio_unlink $pathname, $callback->($status)	306	=item aio_unlink $pathname, $callback->($status)
229		307
230	Asynchronously unlink (delete) a file and call the callback with the	308	Asynchronously unlink (delete) a file and call the callback with the
231	result code.	309	result code.
232		310
		311	=item aio_link $srcpath, $dstpath, $callback->($status)
		312
		313	Asynchronously create a new link to the existing object at C<$srcpath> at
		314	the path C<$dstpath> and call the callback with the result code.
		315
		316	=item aio_symlink $srcpath, $dstpath, $callback->($status)
		317
		318	Asynchronously create a new symbolic link to the existing object at C<$srcpath> at
		319	the path C<$dstpath> and call the callback with the result code.
		320
		321	=item aio_rename $srcpath, $dstpath, $callback->($status)
		322
		323	Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
		324	rename(2) and call the callback with the result code.
		325
233	=item aio_rmdir $pathname, $callback->($status)	326	=item aio_rmdir $pathname, $callback->($status)
234		327
235	Asynchronously rmdir (delete) a directory and call the callback with the	328	Asynchronously rmdir (delete) a directory and call the callback with the
236	result code.	329	result code.
237		330
238	=item aio_readdir $pathname $callback->($entries)	331	=item aio_readdir $pathname, $callback->($entries)
239		332
240	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire	333	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
241	directory (i.e. opendir + readdir + closedir). The entries will not be	334	directory (i.e. opendir + readdir + closedir). The entries will not be
242	sorted, and will B<NOT> include the C<.> and C<..> entries.	335	sorted, and will B<NOT> include the C<.> and C<..> entries.
243		336
244	The callback a single argument which is either C<undef> or an array-ref	337	The callback a single argument which is either C<undef> or an array-ref
245	with the filenames.	338	with the filenames.
246		339
247	=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)	340	=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
248		341
249	Scans a directory (similar to C<aio_readdir>) and tries to separate the	342	Scans a directory (similar to C<aio_readdir>) but additionally tries to
250	entries of directory C<$path> into two sets of names, ones you can recurse	343	separate the entries of directory C<$path> into two sets of names, ones
251	into (directories), and ones you cannot recurse into (everything else).	344	you can recurse into (directories or links to them), and ones you cannot
		345	recurse into (everything else).
252		346
253	C<aio_scandir> is a composite request that consists of many	347	C<aio_scandir> is a composite request that consists of many sub
254	aio-primitives. C<$maxreq> specifies the maximum number of outstanding	348	requests. C<$maxreq> specifies the maximum number of outstanding aio
255	aio requests that this function generates. If it is C<< <= 0 >>, then a	349	requests that this function generates. If it is C<< <= 0 >>, then a
256	suitable default will be chosen (currently 8).	350	suitable default will be chosen (currently 8).
257		351
258	On error, the callback is called without arguments, otherwise it receives	352	On error, the callback is called without arguments, otherwise it receives
259	two array-refs with path-relative entry names.	353	two array-refs with path-relative entry names.
260		354
…		…
269	Implementation notes.	363	Implementation notes.
270		364
271	The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can.	365	The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can.
272		366
273	After reading the directory, the modification time, size etc. of the	367	After reading the directory, the modification time, size etc. of the
274	directory before and after the readdir is checked, and if they match, the	368	directory before and after the readdir is checked, and if they match (and
275	link count will be used to decide how many entries are directories (if	369	isn't the current time), the link count will be used to decide how many
276	>= 2). Otherwise, no knowledge of the number of subdirectories will be	370	entries are directories (if >= 2). Otherwise, no knowledge of the number
277	assumed.	371	of subdirectories will be assumed.
278		372
279	Then entires will be sorted into likely directories (everything without a	373	Then entries will be sorted into likely directories (everything without
280	non-initial dot) and likely non-directories (everything else). Then every	374	a non-initial dot currently) and likely non-directories (everything
281	entry + C</.> will be C<stat>'ed, likely directories first. This is often	375	else). Then every entry plus an appended C</.> will be C<stat>'ed,
		376	likely directories first. If that succeeds, it assumes that the entry
		377	is a directory or a symlink to directory (which will be checked
		378	seperately). This is often faster than stat'ing the entry itself because
282	faster because filesystems might detect the type of the entry without	379	filesystems might detect the type of the entry without reading the inode
283	reading the inode data (e.g. ext2s filetype feature). If that succeeds,	380	data (e.g. ext2fs filetype feature).
284	it assumes that the entry is a directory or a symlink to directory (which
285	will be checked seperately).
286		381
287	If the known number of directories has been reached, the rest of the	382	If the known number of directories (link count - 2) has been reached, the
288	entries is assumed to be non-directories.	383	rest of the entries is assumed to be non-directories.
		384
		385	This only works with certainty on POSIX (= UNIX) filesystems, which
		386	fortunately are the vast majority of filesystems around.
		387
		388	It will also likely work on non-POSIX filesystems with reduced efficiency
		389	as those tend to return 0 or 1 as link counts, which disables the
		390	directory counting heuristic.
289		391
290	=cut	392	=cut
291		393
292	sub aio_scandir($$$) {	394	sub aio_scandir($$$) {
293	my ($path, $maxreq, $cb) = @_;	395	my ($path, $maxreq, $cb) = @_;
294		396
295	$maxreq = 8 if $maxreq <= 0;	397	$maxreq = 8 if $maxreq <= 0;
296		398
297	# stat once	399	# stat once
298	aio_stat $path, sub {	400	aio_stat $path, sub {
299	$cb->() if $_[0];	401	return $cb->() if $_[0];
		402	my $now = time;
300	my $hash1 = join ":", (stat _)[0,1,3,7,9];	403	my $hash1 = join ":", (stat _)[0,1,3,7,9];
301		404
302	# read the directory entries	405	# read the directory entries
303	aio_readdir $path, sub {	406	aio_readdir $path, sub {
304	my $entries = shift	407	my $entries = shift
…		…
309	my $hash2 = join ":", (stat _)[0,1,3,7,9];	412	my $hash2 = join ":", (stat _)[0,1,3,7,9];
310		413
311	my $ndirs;	414	my $ndirs;
312		415
313	# take the slow route if anything looks fishy	416	# take the slow route if anything looks fishy
314	if ($hash1 ne $hash2) {	417	if ($hash1 ne $hash2 or (stat _)[9] == $now) {
315	$ndirs = -1;	418	$ndirs = -1;
316	} else {	419	} else {
317	# if nlink == 2, we are finished	420	# if nlink == 2, we are finished
318	# on non-posix-fs's, we rely on nlink < 2	421	# on non-posix-fs's, we rely on nlink < 2
319	$ndirs = (stat _)[3] - 2	422	$ndirs = (stat _)[3] - 2
320	or $cb->([], $entries);	423	or return $cb->([], $entries);
321	}	424	}
322		425
323	# sort into likely dirs and likely nondirs	426	# sort into likely dirs and likely nondirs
324	# dirs == files without ".", short entries first	427	# dirs == files without ".", short entries first
325	$entries = [map $_->[0],	428	$entries = [map $_->[0],
…		…
341	}	444	}
342	} elsif (!$nreq) {	445	} elsif (!$nreq) {
343	# finished	446	# finished
344	undef $statcb;	447	undef $statcb;
345	undef $schedcb;	448	undef $schedcb;
346	$cb->(\@dirs, \@nondirs);	449	$cb->(\@dirs, \@nondirs) if $cb;
347	undef $cb;	450	undef $cb;
348	}	451	}
349	};	452	};
350	$statcb = sub {	453	$statcb = sub {
351	my ($status, $entry) = @_;	454	my ($status, $entry) = @_;
…		…
392	callback with the fdatasync result code.	495	callback with the fdatasync result code.
393		496
394	If this call isn't available because your OS lacks it or it couldn't be	497	If this call isn't available because your OS lacks it or it couldn't be
395	detected, it will be emulated by calling C<fsync> instead.	498	detected, it will be emulated by calling C<fsync> instead.
396		499
		500	=item aio_group $callback->()
		501
		502	=item aio_sleep $fractional_seconds, $callback->() NOT EXPORTED
		503
		504	Mainly used for debugging and benchmarking, this aio request puts one of
		505	the request workers to sleep for the given time.
		506
		507	=back
		508
		509	=head2 IO::AIO::REQ CLASS
		510
		511	All non-aggregate C<aio_*> functions return an object of this class when
		512	called in non-void context.
		513
		514	A request always moves through the following five states in its lifetime,
		515	in order: B<ready> (request has been created, but has not been executed
		516	yet), B<execute> (request is currently being executed), B<pending>
		517	(request has been executed but callback has not been called yet),
		518	B<result> (results are being processed synchronously, includes calling the
		519	callback) and B<done> (request has reached the end of its lifetime and
		520	holds no resources anymore).
		521
		522	=over 4
		523
		524	=item $req->cancel
		525
		526	Cancels the request, if possible. Has the effect of skipping execution
		527	when entering the B<execute> state and skipping calling the callback when
		528	entering the the B<result> state, but will leave the request otherwise
		529	untouched. That means that requests that currently execute will not be
		530	stopped and resources held by the request will not be freed prematurely.
		531
397	=back	532	=back
398		533
399	=head2 SUPPORT FUNCTIONS	534	=head2 SUPPORT FUNCTIONS
400		535
401	=over 4	536	=over 4
…		…
528	}	663	}
529		664
530	1;	665	1;
531		666
532	=head2 FORK BEHAVIOUR	667	=head2 FORK BEHAVIOUR
		668
		669	This module should do "the right thing" when the process using it forks:
533		670
534	Before the fork, IO::AIO enters a quiescent state where no requests	671	Before the fork, IO::AIO enters a quiescent state where no requests
535	can be added in other threads and no results will be processed. After	672	can be added in other threads and no results will be processed. After
536	the fork the parent simply leaves the quiescent state and continues	673	the fork the parent simply leaves the quiescent state and continues
537	request/result processing, while the child clears the request/result	674	request/result processing, while the child clears the request/result
538	queue (so the requests started before the fork will only be handled in	675	queue (so the requests started before the fork will only be handled in
539	the parent). Threats will be started on demand until the limit ste in the	676	the parent). Threads will be started on demand until the limit ste in the
540	parent process has been reached again.	677	parent process has been reached again.
541		678
		679	In short: the parent will, after a short pause, continue as if fork had
		680	not been called, while the child will act as if IO::AIO has not been used
		681	yet.
		682
542	=head1 SEE ALSO	683	=head1 SEE ALSO
543		684
544	L<Coro>, L<Linux::AIO>.	685	L<Coro>, L<Linux::AIO> (obsolete).
545		686
546	=head1 AUTHOR	687	=head1 AUTHOR
547		688
548	Marc Lehmann <schmorp@schmorp.de>	689	Marc Lehmann <schmorp@schmorp.de>
549	http://home.schmorp.de/	690	http://home.schmorp.de/

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.41 by root, Wed Sep 7 17:41:17 2005 UTC vs. Revision 1.54 by root, Sun Oct 22 00:19:05 2006 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.41 by root, Wed Sep 7 17:41:17 2005 UTC vs.
Revision 1.54 by root, Sun Oct 22 00:19:05 2006 UTC