[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.31 by root, Wed Aug 17 05:06:59 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
…		…
137	Reads or writes C<length> bytes from the specified C<fh> and C<offset>	150	Reads or writes C<length> bytes from the specified C<fh> and C<offset>
138	into the scalar given by C<data> and offset C<dataoffset> and calls the	151	into the scalar given by C<data> and offset C<dataoffset> and calls the
139	callback without the actual number of bytes read (or -1 on error, just	152	callback without the actual number of bytes read (or -1 on error, just
140	like the syscall).	153	like the syscall).
141		154
		155	The C<$data> scalar I<MUST NOT> be modified in any way while the request
		156	is outstanding. Modifying it can result in segfaults or WW3 (if the
		157	necessary/optional hardware is installed).
		158
142	Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at	159	Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at
143	offset C<0> within the scalar:	160	offset C<0> within the scalar:
144		161
145	aio_read $fh, 7, 15, $buffer, 0, sub {	162	aio_read $fh, 7, 15, $buffer, 0, sub {
146	$_[0] > 0 or die "read error: $!";	163	$_[0] > 0 or die "read error: $!";
147	print "read $_[0] bytes: <$buffer>\n";	164	print "read $_[0] bytes: <$buffer>\n";
148	};	165	};
149		166
150	=item aio_readahead $fh,$offset,$length, $callback	167	=item aio_readahead $fh,$offset,$length, $callback
151
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		168
156	C<aio_readahead> populates the page cache with data from a file so that	169	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>	170	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	171	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	172	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	173	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	174	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	175	(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.	176	file. The current file offset of the file is left unchanged.
164		177
		178	If that syscall doesn't exist (likely if your OS isn't Linux) it will be
		179	emulated by simply reading the data, which would have a similar effect.
		180
165	=item aio_stat $fh_or_path, $callback	181	=item aio_stat $fh_or_path, $callback
166		182
167	=item aio_lstat $fh, $callback	183	=item aio_lstat $fh, $callback
168		184
169	Works like perl's C<stat> or C<lstat> in void context. The callback will	185	Works like perl's C<stat> or C<lstat> in void context. The callback will
…		…
187	=item aio_unlink $pathname, $callback	203	=item aio_unlink $pathname, $callback
188		204
189	Asynchronously unlink (delete) a file and call the callback with the	205	Asynchronously unlink (delete) a file and call the callback with the
190	result code.	206	result code.
191		207
		208	=item aio_rmdir $pathname, $callback
		209
		210	Asynchronously rmdir (delete) a directory and call the callback with the
		211	result code.
		212
192	=item aio_fsync $fh, $callback	213	=item aio_fsync $fh, $callback
193		214
194	Asynchronously call fsync on the given filehandle and call the callback	215	Asynchronously call fsync on the given filehandle and call the callback
195	with the fsync result code.	216	with the fsync result code.
196		217
197	=item aio_fdatasync $fh, $callback	218	=item aio_fdatasync $fh, $callback
198		219
199	Asynchronously call fdatasync on the given filehandle and call the	220	Asynchronously call fdatasync on the given filehandle and call the
200	callback with the fdatasync result code. Might set C<$!> to C<ENOSYS> if	221	callback with the fdatasync result code.
201	C<fdatasync> is not available.	222
		223	If this call isn't available because your OS lacks it or it couldn't be
		224	detected, it will be emulated by calling C<fsync> instead.
202		225
203	=back	226	=back
204		227
205	=head2 SUPPORT FUNCTIONS	228	=head2 SUPPORT FUNCTIONS
206		229
…		…
308		331
309	# support function to convert a fd into a perl filehandle	332	# support function to convert a fd into a perl filehandle
310	sub _fd2fh {	333	sub _fd2fh {
311	return undef if $_[0] < 0;	334	return undef if $_[0] < 0;
312		335
313	# try to be perl5.6-compatible	336	# try to generate nice filehandles
314	local *AIO_FH;	337	my $sym = "IO::AIO::fd#$_[0]";
315	open AIO_FH, "+<&=$_[0]"	338	local *$sym;
		339
		340	open *$sym, "+<&=$_[0]" # usually works under any unix
		341	or open *$sym, "<&=$_[0]" # cygwin needs this
		342	or open *$sym, ">&=$_[0]" # or this
316	or return undef;	343	or return undef;
317		344
318	*AIO_FH	345	*$sym
319	}	346	}
320		347
321	min_parallel 4;	348	min_parallel 4;
322		349
323	END {	350	END {
324	max_parallel 0;	351	max_parallel 0;
325	}	352	}
326		353
327	1;	354	1;
328		355
		356	=head2 FORK BEHAVIOUR
		357
		358	Before the fork IO::AIO enters a quiescent state where no requests can be
		359	added in other threads and no results will be processed. After the fork
		360	the parent simply leaves the quiescent state and continues request/result
		361	processing, while the child clears the request/result queue and starts the
		362	same number of threads as were in use by the parent.
		363
329	=head1 SEE ALSO	364	=head1 SEE ALSO
330		365
331	L<Coro>, L<Linux::AIO>.	366	L<Coro>, L<Linux::AIO>.
332		367
333	=head1 AUTHOR	368	=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.31 by root, Wed Aug 17 05:06:59 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.31 by root, Wed Aug 17 05:06:59 2005 UTC