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

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.20 by root, Tue Jul 12 11:29:40 2005 UTC vs.
Revision 1.32 by root, Wed Aug 17 05:26:20 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.5;	68	$VERSION = 1.3;
		69
65		70
66	@EXPORT = qw(aio_read aio_write aio_open aio_close aio_stat aio_lstat aio_unlink	71	@EXPORT = qw(aio_read aio_write aio_open aio_close aio_stat aio_lstat aio_unlink
67	aio_fsync aio_fdatasync aio_readahead);	72	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);	73	@EXPORT_OK = qw(poll_fileno poll_cb min_parallel max_parallel max_outstanding nreqs);
69		74
70	require XSLoader;	75	require XSLoader;
71	XSLoader::load IO::AIO, $VERSION;	76	XSLoader::load IO::AIO, $VERSION;
72	}	77	}
…		…
81	which must be a code reference. This code reference will get called with	86	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	87	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	88	perl, which usually delivers "false") as it's sole argument when the given
84	syscall has been executed asynchronously.	89	syscall has been executed asynchronously.
85		90
86	All functions that expect a filehandle will also accept a file descriptor.	91	All functions expecting a filehandle keep a copy of the filehandle
		92	internally until the request has finished.
87		93
88	The filenames you pass to these routines I<must> be absolute. The reason	94	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	95	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	96	request is being executed, the current working directory could have
91	that you never change the current working directory.	97	changed. Alternatively, you can make sure that you never change the
		98	current working directory.
		99
		100	To encode pathnames to byte form, either make sure you either: a)
		101	always pass in filenames you got from outside (command line, readdir
		102	etc.), b) are ASCII or ISO 8859-1, c) use the Encode module and encode
		103	your pathnames to the locale (or other) encoding in effect in the user
		104	environment, d) use Glib::filename_from_unicode on unicode filenames or e)
		105	use something else.
92		106
93	=over 4	107	=over 4
94		108
95	=item aio_open $pathname, $flags, $mode, $callback	109	=item aio_open $pathname, $flags, $mode, $callback
96		110
…		…
137	Reads or writes C<length> bytes from the specified C<fh> and C<offset>	151	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	152	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	153	callback without the actual number of bytes read (or -1 on error, just
140	like the syscall).	154	like the syscall).
141		155
		156	The C<$data> scalar I<MUST NOT> be modified in any way while the request
		157	is outstanding. Modifying it can result in segfaults or WW3 (if the
		158	necessary/optional hardware is installed).
		159
142	Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at	160	Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at
143	offset C<0> within the scalar:	161	offset C<0> within the scalar:
144		162
145	aio_read $fh, 7, 15, $buffer, 0, sub {	163	aio_read $fh, 7, 15, $buffer, 0, sub {
146	$_[0] > 0 or die "read error: $!";	164	$_[0] > 0 or die "read error: $!";
147	print "read $_[0] bytes: <$buffer>\n";	165	print "read $_[0] bytes: <$buffer>\n";
148	};	166	};
149		167
150	=item aio_readahead $fh,$offset,$length, $callback	168	=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		169
156	C<aio_readahead> populates the page cache with data from a file so that	170	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>	171	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	172	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	173	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	174	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	175	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	176	(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.	177	file. The current file offset of the file is left unchanged.
164		178
		179	If that syscall doesn't exist (likely if your OS isn't Linux) it will be
		180	emulated by simply reading the data, which would have a similar effect.
		181
165	=item aio_stat $fh_or_path, $callback	182	=item aio_stat $fh_or_path, $callback
166		183
167	=item aio_lstat $fh, $callback	184	=item aio_lstat $fh, $callback
168		185
169	Works like perl's C<stat> or C<lstat> in void context. The callback will	186	Works like perl's C<stat> or C<lstat> in void context. The callback will
…		…
187	=item aio_unlink $pathname, $callback	204	=item aio_unlink $pathname, $callback
188		205
189	Asynchronously unlink (delete) a file and call the callback with the	206	Asynchronously unlink (delete) a file and call the callback with the
190	result code.	207	result code.
191		208
		209	=item aio_rmdir $pathname, $callback
		210
		211	Asynchronously rmdir (delete) a directory and call the callback with the
		212	result code.
		213
192	=item aio_fsync $fh, $callback	214	=item aio_fsync $fh, $callback
193		215
194	Asynchronously call fsync on the given filehandle and call the callback	216	Asynchronously call fsync on the given filehandle and call the callback
195	with the fsync result code.	217	with the fsync result code.
196		218
197	=item aio_fdatasync $fh, $callback	219	=item aio_fdatasync $fh, $callback
198		220
199	Asynchronously call fdatasync on the given filehandle and call the	221	Asynchronously call fdatasync on the given filehandle and call the
200	callback with the fdatasync result code. Might set C<$!> to C<ENOSYS> if	222	callback with the fdatasync result code.
201	C<fdatasync> is not available.	223
		224	If this call isn't available because your OS lacks it or it couldn't be
		225	detected, it will be emulated by calling C<fsync> instead.
202		226
203	=back	227	=back
204		228
205	=head2 SUPPORT FUNCTIONS	229	=head2 SUPPORT FUNCTIONS
206		230
…		…
308		332
309	# support function to convert a fd into a perl filehandle	333	# support function to convert a fd into a perl filehandle
310	sub _fd2fh {	334	sub _fd2fh {
311	return undef if $_[0] < 0;	335	return undef if $_[0] < 0;
312		336
313	# try to be perl5.6-compatible	337	# try to generate nice filehandles
314	local *AIO_FH;	338	my $sym = "IO::AIO::fd#$_[0]";
315	open AIO_FH, "+<&=$_[0]"	339	local *$sym;
		340
		341	open *$sym, "+<&=$_[0]" # usually works under any unix
		342	or open *$sym, "<&=$_[0]" # cygwin needs this
		343	or open *$sym, ">&=$_[0]" # or this
316	or return undef;	344	or return undef;
317		345
318	*AIO_FH	346	*$sym
319	}	347	}
320		348
321	min_parallel 4;	349	min_parallel 4;
322		350
323	END {	351	END {
324	max_parallel 0;	352	max_parallel 0;
325	}	353	}
326		354
327	1;	355	1;
328		356
		357	=head2 FORK BEHAVIOUR
		358
		359	Before the fork IO::AIO enters a quiescent state where no requests can be
		360	added in other threads and no results will be processed. After the fork
		361	the parent simply leaves the quiescent state and continues request/result
		362	processing, while the child clears the request/result queue and starts the
		363	same number of threads as were in use by the parent.
		364
329	=head1 SEE ALSO	365	=head1 SEE ALSO
330		366
331	L<Coro>, L<Linux::AIO>.	367	L<Coro>, L<Linux::AIO>.
332		368
333	=head1 AUTHOR	369	=head1 AUTHOR

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.20 by root, Tue Jul 12 11:29:40 2005 UTC vs. Revision 1.32 by root, Wed Aug 17 05:26:20 2005 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.20 by root, Tue Jul 12 11:29:40 2005 UTC vs.
Revision 1.32 by root, Wed Aug 17 05:26:20 2005 UTC