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

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.21 by root, Wed Jul 13 00:13:09 2005 UTC vs.
Revision 1.28 by root, Tue Aug 16 23:33:34 2005 UTC

…		…
22	poll => 'r',	22	poll => 'r',
23	cb => \&IO::AIO::poll_cb);	23	cb => \&IO::AIO::poll_cb);
24		24
25	# Glib/Gtk2	25	# Glib/Gtk2
26	add_watch Glib::IO IO::AIO::poll_fileno,	26	add_watch Glib::IO IO::AIO::poll_fileno,
27	in => sub { IO::AIO::poll_cb, 1 };	27	in => sub { IO::AIO::poll_cb; 1 };
28		28
29	# Tk	29	# Tk
30	Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",	30	Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
31	readable => \&IO::AIO::poll_cb);	31	readable => \&IO::AIO::poll_cb);
32		32
…		…
48	not well-supported (Linux doesn't allow them on normal files currently,	48	not well-supported (Linux doesn't allow them on normal files currently,
49	for example), and they would only support aio_read and aio_write, so the	49	for example), and they would only support aio_read and aio_write, so the
50	remaining functionality would have to be implemented using threads anyway.	50	remaining functionality would have to be implemented using threads anyway.
51		51
52	Although the module will work with in the presence of other threads, it is	52	Although the module will work with in the presence of other threads, it is
53	currently not reentrant, so use appropriate locking yourself.	53	currently not reentrant, so use appropriate locking yourself, always call
		54	C<poll_cb> from within the same thread, or never call C<poll_cb> (or other
		55	C<aio_> functions) recursively.
54		56
55	=cut	57	=cut
56		58
57	package IO::AIO;	59	package IO::AIO;
58		60
		61	no warnings;
		62
59	use base 'Exporter';	63	use base 'Exporter';
60		64
61	use Fcntl ();	65	use Fcntl ();
62		66
63	BEGIN {	67	BEGIN {
64	$VERSION = 0.9;	68	$VERSION = 1.2;
65		69
66	@EXPORT = qw(aio_read aio_write aio_open aio_close aio_stat aio_lstat aio_unlink	70	@EXPORT = qw(aio_read aio_write aio_open aio_close aio_stat aio_lstat aio_unlink
67	aio_fsync aio_fdatasync aio_readahead);	71	aio_rmdir aio_symlink aio_fsync aio_fdatasync aio_readahead);
68	@EXPORT_OK = qw(poll_fileno poll_cb min_parallel max_parallel max_outstanding nreqs);	72	@EXPORT_OK = qw(poll_fileno poll_cb min_parallel max_parallel max_outstanding nreqs);
69		73
70	require XSLoader;	74	require XSLoader;
71	XSLoader::load IO::AIO, $VERSION;	75	XSLoader::load IO::AIO, $VERSION;
72	}	76	}
…		…
81	which must be a code reference. This code reference will get called with	85	which must be a code reference. This code reference will get called with
82	the syscall return code (e.g. most syscalls return C<-1> on error, unlike	86	the syscall return code (e.g. most syscalls return C<-1> on error, unlike
83	perl, which usually delivers "false") as it's sole argument when the given	87	perl, which usually delivers "false") as it's sole argument when the given
84	syscall has been executed asynchronously.	88	syscall has been executed asynchronously.
85		89
86	All functions that expect a filehandle will also accept a file descriptor.	90	All functions expecting a filehandle keep a copy of the filehandle
		91	internally until the request has finished.
87		92
88	The filenames you pass to these routines I<must> be absolute. The reason	93	The pathnames you pass to these routines I<must> be absolute and
89	for this is that at the time the request is being executed, the current	94	encoded in byte form. The reason for the former is that at the time the
90	working directory could have changed. Alternatively, you can make sure	95	request is being executed, the current working directory could have
91	that you never change the current working directory.	96	changed. Alternatively, you can make sure that you never change the
		97	current working directory.
		98
		99	To encode pathnames to byte form, either make sure you either: a)
		100	always pass in filenames you got from outside (command line, readdir
		101	etc.), b) are ASCII or ISO 8859-1, c) use the Encode module and encode
		102	your pathnames to the locale (or other) encoding in effect in the user
		103	environment, d) use Glib::filename_from_unicode on unicode filenames or e)
		104	use something else.
92		105
93	=over 4	106	=over 4
94		107
95	=item aio_open $pathname, $flags, $mode, $callback	108	=item aio_open $pathname, $flags, $mode, $callback
96		109
…		…
147	print "read $_[0] bytes: <$buffer>\n";	160	print "read $_[0] bytes: <$buffer>\n";
148	};	161	};
149		162
150	=item aio_readahead $fh,$offset,$length, $callback	163	=item aio_readahead $fh,$offset,$length, $callback
151		164
152	Asynchronously reads the specified byte range into the page cache, using
153	the C<readahead> syscall. If that syscall doesn't exist (likely if your OS
154	isn't Linux) the status will be C<-1> and C<$!> is set to C<ENOSYS>.
155
156	C<aio_readahead> populates the page cache with data from a file so that	165	C<aio_readahead> populates the page cache with data from a file so that
157	subsequent reads from that file will not block on disk I/O. The C<$offset>	166	subsequent reads from that file will not block on disk I/O. The C<$offset>
158	argument specifies the starting point from which data is to be read and	167	argument specifies the starting point from which data is to be read and
159	C<$length> specifies the number of bytes to be read. I/O is performed in	168	C<$length> specifies the number of bytes to be read. I/O is performed in
160	whole pages, so that offset is effectively rounded down to a page boundary	169	whole pages, so that offset is effectively rounded down to a page boundary
161	and bytes are read up to the next page boundary greater than or equal to	170	and bytes are read up to the next page boundary greater than or equal to
162	(off-set+length). C<aio_readahead> does not read beyond the end of the	171	(off-set+length). C<aio_readahead> does not read beyond the end of the
163	file. The current file offset of the file is left unchanged.	172	file. The current file offset of the file is left unchanged.
164		173
		174	If that syscall doesn't exist (likely if your OS isn't Linux) it will be
		175	emulated by simply reading the data, which would have a similar effect.
		176
165	=item aio_stat $fh_or_path, $callback	177	=item aio_stat $fh_or_path, $callback
166		178
167	=item aio_lstat $fh, $callback	179	=item aio_lstat $fh, $callback
168		180
169	Works like perl's C<stat> or C<lstat> in void context. The callback will	181	Works like perl's C<stat> or C<lstat> in void context. The callback will
…		…
187	=item aio_unlink $pathname, $callback	199	=item aio_unlink $pathname, $callback
188		200
189	Asynchronously unlink (delete) a file and call the callback with the	201	Asynchronously unlink (delete) a file and call the callback with the
190	result code.	202	result code.
191		203
		204	=item aio_rmdir $pathname, $callback
		205
		206	Asynchronously rmdir (delete) a directory and call the callback with the
		207	result code.
		208
192	=item aio_fsync $fh, $callback	209	=item aio_fsync $fh, $callback
193		210
194	Asynchronously call fsync on the given filehandle and call the callback	211	Asynchronously call fsync on the given filehandle and call the callback
195	with the fsync result code.	212	with the fsync result code.
196		213
197	=item aio_fdatasync $fh, $callback	214	=item aio_fdatasync $fh, $callback
198		215
199	Asynchronously call fdatasync on the given filehandle and call the	216	Asynchronously call fdatasync on the given filehandle and call the
200	callback with the fdatasync result code. Might set C<$!> to C<ENOSYS> if	217	callback with the fdatasync result code.
201	C<fdatasync> is not available.	218
		219	If this call isn't available because your OS lacks it or it couldn't be
		220	detected, it will be emulated by calling C<fsync> instead.
202		221
203	=back	222	=back
204		223
205	=head2 SUPPORT FUNCTIONS	224	=head2 SUPPORT FUNCTIONS
206		225
…		…
308		327
309	# support function to convert a fd into a perl filehandle	328	# support function to convert a fd into a perl filehandle
310	sub _fd2fh {	329	sub _fd2fh {
311	return undef if $_[0] < 0;	330	return undef if $_[0] < 0;
312		331
313	# try to be perl5.6-compatible	332	# try to generate nice filehandles
314	local *AIO_FH;	333	my $sym = "IO::AIO::fd#$_[0]";
315	open AIO_FH, "+<&=$_[0]"	334	local *$sym;
		335
		336	open *$sym, "+<&=$_[0]" # usually works under any unix
		337	or open *$sym, "<&=$_[0]" # cygwin needs this
		338	or open *$sym, ">&=$_[0]" # or this
316	or return undef;	339	or return undef;
317		340
318	*AIO_FH	341	*$sym
319	}	342	}
320		343
321	min_parallel 4;	344	min_parallel 4;
322		345
323	END {	346	END {
324	max_parallel 0;	347	max_parallel 0;
325	}	348	}
326		349
327	1;	350	1;
328		351
		352	=head2 FORK BEHAVIOUR
		353
		354	IO::AIO handles all outstanding AIO requests before the fork, destroys all
		355	AIO threads, and recreates them in both the parent and the child after the
		356	fork.
		357
		358
329	=head1 SEE ALSO	359	=head1 SEE ALSO
330		360
331	L<Coro>, L<Linux::AIO>.	361	L<Coro>, L<Linux::AIO>.
332		362
333	=head1 AUTHOR	363	=head1 AUTHOR

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.21 by root, Wed Jul 13 00:13:09 2005 UTC vs. Revision 1.28 by root, Tue Aug 16 23:33:34 2005 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.21 by root, Wed Jul 13 00:13:09 2005 UTC vs.
Revision 1.28 by root, Tue Aug 16 23:33:34 2005 UTC