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

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.50 by root, Sat Jun 24 16:27:02 2006 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
19		24
20	# AnyEvent	25	# AnyEvent
21	open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!";	26	open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!";
22	my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb });	27	my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb });
23		28
…		…
61	=cut	66	=cut
62		67
63	package IO::AIO;	68	package IO::AIO;
64		69
65	no warnings;	70	no warnings;
		71	use strict 'vars';
66		72
67	use base 'Exporter';	73	use base 'Exporter';
68		74
69	use Fcntl ();
70
71	BEGIN {	75	BEGIN {
72	$VERSION = '1.8';	76	our $VERSION = '1.99';
73		77
74	@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
75	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
76	aio_fsync aio_fdatasync aio_readahead aio_rename aio_link aio_move);	80	aio_fsync aio_fdatasync aio_readahead aio_rename aio_link aio_move
		81	aio_group);
77	@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);
78	max_outstanding nreqs);	83
		84	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';
79		85
80	require XSLoader;	86	require XSLoader;
81	XSLoader::load IO::AIO, $VERSION;	87	XSLoader::load ("IO::AIO", $VERSION);
82	}	88	}
83		89
84	=head1 FUNCTIONS	90	=head1 FUNCTIONS
85		91
86	=head2 AIO FUNCTIONS	92	=head2 AIO FUNCTIONS
…		…
93	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
94	syscall has been executed asynchronously.	100	syscall has been executed asynchronously.
95		101
96	All functions expecting a filehandle keep a copy of the filehandle	102	All functions expecting a filehandle keep a copy of the filehandle
97	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.
98		108
99	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
100	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
101	request is being executed, the current working directory could have	111	request is being executed, the current working directory could have
102	changed. Alternatively, you can make sure that you never change the	112	changed. Alternatively, you can make sure that you never change the
…		…
170	print "read $_[0] bytes: <$buffer>\n";	180	print "read $_[0] bytes: <$buffer>\n";
171	};	181	};
172		182
173	=item aio_move $srcpath, $dstpath, $callback->($status)	183	=item aio_move $srcpath, $dstpath, $callback->($status)
174		184
175	[EXPERIMENTAL]
176
177	Try to move the I<file> (directories not supported as either source or destination)	185	Try to move the I<file> (directories not supported as either source or
178	from C<$srcpath> to C<$dstpath> and call the callback with the C<0> (error) or C<-1> ok.	186	destination) from C<$srcpath> to C<$dstpath> and call the callback with
		187	the C<0> (error) or C<-1> ok.
179		188
180	This is a composite request that tries to rename(2) the file first. If	189	This is a composite request that tries to rename(2) the file first. If
181	rename files with C<EXDEV>, it creates the destination file with mode 0200	190	rename files with C<EXDEV>, it creates the destination file with mode 0200
182	and copies the contents of the source file into it using C<aio_sendfile>,	191	and copies the contents of the source file into it using C<aio_sendfile>,
183	followed by restoring atime, mtime, access mode and uid/gid, in that	192	followed by restoring atime, mtime, access mode and uid/gid, in that
…		…
191		200
192	sub aio_move($$$) {	201	sub aio_move($$$) {
193	my ($src, $dst, $cb) = @_;	202	my ($src, $dst, $cb) = @_;
194		203
195	aio_rename $src, $dst, sub {	204	aio_rename $src, $dst, sub {
196	if ($_[0] && $! == Errno::EXDEV) {	205	if ($_[0] && $! == EXDEV) {
197	aio_open $src, O_RDONLY, 0, sub {	206	aio_open $src, O_RDONLY, 0, sub {
198	if (my $src_fh = $_[0]) {	207	if (my $src_fh = $_[0]) {
199	my @stat = stat $src_fh;	208	my @stat = stat $src_fh;
200		209
201	aio_open $dst, O_WRONLY, 0200, sub {	210	aio_open $dst, O_WRONLY, 0200, sub {
…		…
328	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
329	with the filenames.	338	with the filenames.
330		339
331	=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)	340	=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
332		341
333	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
334	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
335	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).
336		346
337	C<aio_scandir> is a composite request that consists of many	347	C<aio_scandir> is a composite request that consists of many sub
338	aio-primitives. C<$maxreq> specifies the maximum number of outstanding	348	requests. C<$maxreq> specifies the maximum number of outstanding aio
339	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
340	suitable default will be chosen (currently 8).	350	suitable default will be chosen (currently 8).
341		351
342	On error, the callback is called without arguments, otherwise it receives	352	On error, the callback is called without arguments, otherwise it receives
343	two array-refs with path-relative entry names.	353	two array-refs with path-relative entry names.
344		354
…		…
353	Implementation notes.	363	Implementation notes.
354		364
355	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.
356		366
357	After reading the directory, the modification time, size etc. of the	367	After reading the directory, the modification time, size etc. of the
358	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
359	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
360	>= 2). Otherwise, no knowledge of the number of subdirectories will be	370	entries are directories (if >= 2). Otherwise, no knowledge of the number
361	assumed.	371	of subdirectories will be assumed.
362		372
363	Then entires will be sorted into likely directories (everything without a	373	Then entries will be sorted into likely directories (everything without
364	non-initial dot) and likely non-directories (everything else). Then every	374	a non-initial dot currently) and likely non-directories (everything
365	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
366	faster because filesystems might detect the type of the entry without	379	filesystems might detect the type of the entry without reading the inode
367	reading the inode data (e.g. ext2fs filetype feature). If that succeeds,	380	data (e.g. ext2fs filetype feature).
368	it assumes that the entry is a directory or a symlink to directory (which
369	will be checked seperately).
370		381
371	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
372	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.
373		391
374	=cut	392	=cut
375		393
376	sub aio_scandir($$$) {	394	sub aio_scandir($$$) {
377	my ($path, $maxreq, $cb) = @_;	395	my ($path, $maxreq, $cb) = @_;
…		…
379	$maxreq = 8 if $maxreq <= 0;	397	$maxreq = 8 if $maxreq <= 0;
380		398
381	# stat once	399	# stat once
382	aio_stat $path, sub {	400	aio_stat $path, sub {
383	return $cb->() if $_[0];	401	return $cb->() if $_[0];
		402	my $now = time;
384	my $hash1 = join ":", (stat _)[0,1,3,7,9];	403	my $hash1 = join ":", (stat _)[0,1,3,7,9];
385		404
386	# read the directory entries	405	# read the directory entries
387	aio_readdir $path, sub {	406	aio_readdir $path, sub {
388	my $entries = shift	407	my $entries = shift
…		…
393	my $hash2 = join ":", (stat _)[0,1,3,7,9];	412	my $hash2 = join ":", (stat _)[0,1,3,7,9];
394		413
395	my $ndirs;	414	my $ndirs;
396		415
397	# take the slow route if anything looks fishy	416	# take the slow route if anything looks fishy
398	if ($hash1 ne $hash2) {	417	if ($hash1 ne $hash2 or (stat _)[9] == $now) {
399	$ndirs = -1;	418	$ndirs = -1;
400	} else {	419	} else {
401	# if nlink == 2, we are finished	420	# if nlink == 2, we are finished
402	# on non-posix-fs's, we rely on nlink < 2	421	# on non-posix-fs's, we rely on nlink < 2
403	$ndirs = (stat _)[3] - 2	422	$ndirs = (stat _)[3] - 2
…		…
476	callback with the fdatasync result code.	495	callback with the fdatasync result code.
477		496
478	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
479	detected, it will be emulated by calling C<fsync> instead.	498	detected, it will be emulated by calling C<fsync> instead.
480		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
481	=back	532	=back
482		533
483	=head2 SUPPORT FUNCTIONS	534	=head2 SUPPORT FUNCTIONS
484		535
485	=over 4	536	=over 4
…		…
612	}	663	}
613		664
614	1;	665	1;
615		666
616	=head2 FORK BEHAVIOUR	667	=head2 FORK BEHAVIOUR
		668
		669	This module should do "the right thing" when the process using it forks:
617		670
618	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
619	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
620	the fork the parent simply leaves the quiescent state and continues	673	the fork the parent simply leaves the quiescent state and continues
621	request/result processing, while the child clears the request/result	674	request/result processing, while the child clears the request/result
622	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
623	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
624	parent process has been reached again.	677	parent process has been reached again.
625		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
626	=head1 SEE ALSO	683	=head1 SEE ALSO
627		684
628	L<Coro>, L<Linux::AIO>.	685	L<Coro>, L<Linux::AIO> (obsolete).
629		686
630	=head1 AUTHOR	687	=head1 AUTHOR
631		688
632	Marc Lehmann <schmorp@schmorp.de>	689	Marc Lehmann <schmorp@schmorp.de>
633	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.50 by root, Sat Jun 24 16:27:02 2006 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.50 by root, Sat Jun 24 16:27:02 2006 UTC vs.
Revision 1.54 by root, Sun Oct 22 00:19:05 2006 UTC