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

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.3 by root, Sun Jul 10 20:07:11 2005 UTC vs.
Revision 1.26 by root, Sun Aug 7 03:34:07 2005 UTC

…		…
3	IO::AIO - Asynchronous Input/Output	3	IO::AIO - Asynchronous Input/Output
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	use IO::AIO;	7	use IO::AIO;
		8
		9	aio_open "/etc/passwd", O_RDONLY, 0, sub {
		10	my ($fh) = @_;
		11	...
		12	};
		13
		14	aio_unlink "/tmp/file", sub { };
		15
		16	aio_read $fh, 30000, 1024, $buffer, 0, sub {
		17	$_[0] > 0 or die "read error: $!";
		18	};
		19
		20	# Event
		21	Event->io (fd => IO::AIO::poll_fileno,
		22	poll => 'r',
		23	cb => \&IO::AIO::poll_cb);
		24
		25	# Glib/Gtk2
		26	add_watch Glib::IO IO::AIO::poll_fileno,
		27	in => sub { IO::AIO::poll_cb; 1 };
		28
		29	# Tk
		30	Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
		31	readable => \&IO::AIO::poll_cb);
		32
		33	# Danga::Socket
		34	Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
		35	\&IO::AIO::poll_cb);
		36
8		37
9	=head1 DESCRIPTION	38	=head1 DESCRIPTION
10		39
11	This module implements asynchronous I/O using whatever means your	40	This module implements asynchronous I/O using whatever means your
12	operating system supports.	41	operating system supports.
…		…
19	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,
20	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
21	remaining functionality would have to be implemented using threads anyway.	50	remaining functionality would have to be implemented using threads anyway.
22		51
23	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
24	currently not reentrant, so use appropriate locking yourself.	53	currently not reentrant, so use appropriate locking yourself, always call
25		54	C<poll_cb> from within the same thread, or never call C<poll_cb> (or other
26	=head2 API NOTES	55	C<aio_> functions) recursively.
27
28	All the C<aio_*> calls are more or less thin wrappers around the syscall
29	with the same name (sans C<aio_>). The arguments are similar or identical,
30	and they all accept an additional C<$callback> argument which must be
31	a code reference. This code reference will get called with the syscall
32	return code (e.g. most syscalls return C<-1> on error, unlike perl, which
33	usually delivers "false") as it's sole argument when the given syscall has
34	been executed asynchronously.
35
36	All functions that expect a filehandle will also accept a file descriptor.
37
38	The filenames you pass to these routines I<must> be absolute. The reason
39	is that at the time the request is being executed, the current working
40	directory could have changed. Alternatively, you can make sure that you
41	never change the current working directory.
42
43	=over 4
44		56
45	=cut	57	=cut
46		58
47	package IO::AIO;	59	package IO::AIO;
48		60
		61	no warnings;
		62
49	use base 'Exporter';	63	use base 'Exporter';
50		64
51	use Fcntl ();	65	use Fcntl ();
52		66
53	BEGIN {	67	BEGIN {
54	$VERSION = 0.2;	68	$VERSION = 1.1;
55		69
56	@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
57	aio_fsync aio_fdatasync aio_readahead);	71	aio_fsync aio_fdatasync aio_readahead);
58	@EXPORT_OK = qw(poll_fileno poll_cb min_parallel max_parallel nreqs);	72	@EXPORT_OK = qw(poll_fileno poll_cb min_parallel max_parallel max_outstanding nreqs);
59		73
60	require XSLoader;	74	require XSLoader;
61	XSLoader::load IO::AIO, $VERSION;	75	XSLoader::load IO::AIO, $VERSION;
62	}	76	}
63		77
64	=item IO::AIO::min_parallel $nthreads	78	=head1 FUNCTIONS
65		79
66	Set the minimum number of AIO threads to C<$nthreads>. The default is	80	=head2 AIO FUNCTIONS
67	C<1>, which means a single asynchronous operation can be done at one time
68	(the number of outstanding operations, however, is unlimited).
69		81
70	It is recommended to keep the number of threads low, as some linux	82	All the C<aio_*> calls are more or less thin wrappers around the syscall
71	kernel versions will scale negatively with the number of threads (higher	83	with the same name (sans C<aio_>). The arguments are similar or identical,
72	parallelity => MUCH higher latency).	84	and they all accept an additional (and optional) C<$callback> argument
		85	which must be a code reference. This code reference will get called with
		86	the syscall return code (e.g. most syscalls return C<-1> on error, unlike
		87	perl, which usually delivers "false") as it's sole argument when the given
		88	syscall has been executed asynchronously.
73		89
74	Under normal circumstances you don't need to call this function, as this	90	All functions expecting a filehandle keep a copy of the filehandle
75	module automatically starts a single async thread.	91	internally until the request has finished.
76		92
77	=item IO::AIO::max_parallel $nthreads	93	The filenames you pass to these routines I<must> be absolute. The reason
		94	for this is that at the time the request is being executed, the current
		95	working directory could have changed. Alternatively, you can make sure
		96	that you never change the current working directory.
78		97
79	Sets the maximum number of AIO threads to C<$nthreads>. If more than	98	=over 4
80	the specified number of threads are currently running, kill them. This
81	function blocks until the limit is reached.
82
83	This module automatically runs C<max_parallel 0> at program end, to ensure
84	that all threads are killed and that there are no outstanding requests.
85
86	Under normal circumstances you don't need to call this function.
87
88	=item $fileno = IO::AIO::poll_fileno
89
90	Return the I<request result pipe filehandle>. This filehandle must be
91	polled for reading by some mechanism outside this module (e.g. Event
92	or select, see below). If the pipe becomes readable you have to call
93	C<poll_cb> to check the results.
94
95	See C<poll_cb> for an example.
96
97	=item IO::AIO::poll_cb
98
99	Process all outstanding events on the result pipe. You have to call this
100	regularly. Returns the number of events processed. Returns immediately
101	when no events are outstanding.
102
103	You can use Event to multiplex, e.g.:
104
105	Event->io (fd => IO::AIO::poll_fileno,
106	poll => 'r', async => 1,
107	cb => \&IO::AIO::poll_cb);
108
109	=item IO::AIO::poll_wait
110
111	Wait till the result filehandle becomes ready for reading (simply does a
112	select on the filehandle. This is useful if you want to synchronously wait
113	for some requests to finish).
114
115	See C<nreqs> for an example.
116
117	=item IO::AIO::nreqs
118
119	Returns the number of requests currently outstanding.
120
121	Example: wait till there are no outstanding requests anymore:
122
123	IO::AIO::poll_wait, IO::AIO::poll_cb
124	while IO::AIO::nreqs;
125		99
126	=item aio_open $pathname, $flags, $mode, $callback	100	=item aio_open $pathname, $flags, $mode, $callback
127		101
128	Asynchronously open or create a file and call the callback with a newly	102	Asynchronously open or create a file and call the callback with a newly
129	created filehandle for the file.	103	created filehandle for the file.
130		104
131	The pathname passed to C<aio_open> must be absolute. See API NOTES, above,	105	The pathname passed to C<aio_open> must be absolute. See API NOTES, above,
132	for an explanation.	106	for an explanation.
133		107
134	The C<$mode> argument is a bitmask. See the C<Fcntl> module for a	108	The C<$flags> argument is a bitmask. See the C<Fcntl> module for a
135	list. They are the same as used in C<sysopen>.	109	list. They are the same as used by C<sysopen>.
		110
		111	Likewise, C<$mode> specifies the mode of the newly created file, if it
		112	didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>,
		113	except that it is mandatory (i.e. use C<0> if you don't create new files,
		114	and C<0666> or C<0777> if you do).
136		115
137	Example:	116	Example:
138		117
139	aio_open "/etc/passwd", O_RDONLY, 0, sub {	118	aio_open "/etc/passwd", O_RDONLY, 0, sub {
140	if ($_[0]) {	119	if ($_[0]) {
…		…
147		126
148	=item aio_close $fh, $callback	127	=item aio_close $fh, $callback
149		128
150	Asynchronously close a file and call the callback with the result	129	Asynchronously close a file and call the callback with the result
151	code. I<WARNING:> although accepted, you should not pass in a perl	130	code. I<WARNING:> although accepted, you should not pass in a perl
152	filehandle here, as perl will likely close the file descriptor itself when	131	filehandle here, as perl will likely close the file descriptor another
153	the filehandle is destroyed. Normally, you can safely call perls C<close>	132	time when the filehandle is destroyed. Normally, you can safely call perls
154	or just let filehandles go out of scope.	133	C<close> or just let filehandles go out of scope.
		134
		135	This is supposed to be a bug in the API, so that might change. It's
		136	therefore best to avoid this function.
155		137
156	=item aio_read $fh,$offset,$length, $data,$dataoffset,$callback	138	=item aio_read $fh,$offset,$length, $data,$dataoffset,$callback
157		139
158	=item aio_write $fh,$offset,$length, $data,$dataoffset,$callback	140	=item aio_write $fh,$offset,$length, $data,$dataoffset,$callback
159		141
160	Reads or writes C<length> bytes from the specified C<fh> and C<offset>	142	Reads or writes C<length> bytes from the specified C<fh> and C<offset>
161	into the scalar given by C<data> and offset C<dataoffset> and calls the	143	into the scalar given by C<data> and offset C<dataoffset> and calls the
162	callback without the actual number of bytes read (or -1 on error, just	144	callback without the actual number of bytes read (or -1 on error, just
163	like the syscall).	145	like the syscall).
164		146
165	Example: Read 15 bytes at offset 7 into scalar C<$buffer>, strating at	147	Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at
166	offset C<0> within the scalar:	148	offset C<0> within the scalar:
167		149
168	aio_read $fh, 7, 15, $buffer, 0, sub {	150	aio_read $fh, 7, 15, $buffer, 0, sub {
169	$_[0] >= 0 or die "read error: $!";	151	$_[0] > 0 or die "read error: $!";
170	print "read <$buffer>\n";	152	print "read $_[0] bytes: <$buffer>\n";
171	};	153	};
172		154
173	=item aio_readahead $fh,$offset,$length, $callback	155	=item aio_readahead $fh,$offset,$length, $callback
174		156
175	Asynchronously reads the specified byte range into the page cache, using
176	the C<readahead> syscall. If that syscall doesn't exist the status will be
177	C<-1> and C<$!> is set to ENOSYS.
178
179	readahead() populates the page cache with data from a file so that	157	C<aio_readahead> populates the page cache with data from a file so that
180	subsequent reads from that file will not block on disk I/O. The C<$offset>	158	subsequent reads from that file will not block on disk I/O. The C<$offset>
181	argument specifies the starting point from which data is to be read and	159	argument specifies the starting point from which data is to be read and
182	C<$length> specifies the number of bytes to be read. I/O is performed in	160	C<$length> specifies the number of bytes to be read. I/O is performed in
183	whole pages, so that offset is effectively rounded down to a page boundary	161	whole pages, so that offset is effectively rounded down to a page boundary
184	and bytes are read up to the next page boundary greater than or equal to	162	and bytes are read up to the next page boundary greater than or equal to
185	(off-set+length). aio_readahead() does not read beyond the end of the	163	(off-set+length). C<aio_readahead> does not read beyond the end of the
186	file. The current file offset of the file is left unchanged.	164	file. The current file offset of the file is left unchanged.
		165
		166	If that syscall doesn't exist (likely if your OS isn't Linux) it will be
		167	emulated by simply reading the data, which would have a similar effect.
187		168
188	=item aio_stat $fh_or_path, $callback	169	=item aio_stat $fh_or_path, $callback
189		170
190	=item aio_lstat $fh, $callback	171	=item aio_lstat $fh, $callback
191		172
…		…
220	=item aio_fdatasync $fh, $callback	201	=item aio_fdatasync $fh, $callback
221		202
222	Asynchronously call fdatasync on the given filehandle and call the	203	Asynchronously call fdatasync on the given filehandle and call the
223	callback with the fdatasync result code.	204	callback with the fdatasync result code.
224		205
		206	If this call isn't available because your OS lacks it or it couldn't be
		207	detected, it will be emulated by calling C<fsync> instead.
		208
		209	=back
		210
		211	=head2 SUPPORT FUNCTIONS
		212
		213	=over 4
		214
		215	=item $fileno = IO::AIO::poll_fileno
		216
		217	Return the I<request result pipe file descriptor>. This filehandle must be
		218	polled for reading by some mechanism outside this module (e.g. Event or
		219	select, see below or the SYNOPSIS). If the pipe becomes readable you have
		220	to call C<poll_cb> to check the results.
		221
		222	See C<poll_cb> for an example.
		223
		224	=item IO::AIO::poll_cb
		225
		226	Process all outstanding events on the result pipe. You have to call this
		227	regularly. Returns the number of events processed. Returns immediately
		228	when no events are outstanding.
		229
		230	Example: Install an Event watcher that automatically calls
		231	IO::AIO::poll_cb with high priority:
		232
		233	Event->io (fd => IO::AIO::poll_fileno,
		234	poll => 'r', async => 1,
		235	cb => \&IO::AIO::poll_cb);
		236
		237	=item IO::AIO::poll_wait
		238
		239	Wait till the result filehandle becomes ready for reading (simply does a
		240	C<select> on the filehandle. This is useful if you want to synchronously wait
		241	for some requests to finish).
		242
		243	See C<nreqs> for an example.
		244
		245	=item IO::AIO::nreqs
		246
		247	Returns the number of requests currently outstanding (i.e. for which their
		248	callback has not been invoked yet).
		249
		250	Example: wait till there are no outstanding requests anymore:
		251
		252	IO::AIO::poll_wait, IO::AIO::poll_cb
		253	while IO::AIO::nreqs;
		254
		255	=item IO::AIO::flush
		256
		257	Wait till all outstanding AIO requests have been handled.
		258
		259	Strictly equivalent to:
		260
		261	IO::AIO::poll_wait, IO::AIO::poll_cb
		262	while IO::AIO::nreqs;
		263
		264	=item IO::AIO::poll
		265
		266	Waits until some requests have been handled.
		267
		268	Strictly equivalent to:
		269
		270	IO::AIO::poll_wait, IO::AIO::poll_cb
		271	if IO::AIO::nreqs;
		272
		273	=item IO::AIO::min_parallel $nthreads
		274
		275	Set the minimum number of AIO threads to C<$nthreads>. The default is
		276	C<1>, which means a single asynchronous operation can be done at one time
		277	(the number of outstanding operations, however, is unlimited).
		278
		279	It is recommended to keep the number of threads low, as some Linux
		280	kernel versions will scale negatively with the number of threads (higher
		281	parallelity => MUCH higher latency). With current Linux 2.6 versions, 4-32
		282	threads should be fine.
		283
		284	Under normal circumstances you don't need to call this function, as this
		285	module automatically starts some threads (the exact number might change,
		286	and is currently 4).
		287
		288	=item IO::AIO::max_parallel $nthreads
		289
		290	Sets the maximum number of AIO threads to C<$nthreads>. If more than
		291	the specified number of threads are currently running, kill them. This
		292	function blocks until the limit is reached.
		293
		294	This module automatically runs C<max_parallel 0> at program end, to ensure
		295	that all threads are killed and that there are no outstanding requests.
		296
		297	Under normal circumstances you don't need to call this function.
		298
		299	=item $oldnreqs = IO::AIO::max_outstanding $nreqs
		300
		301	Sets the maximum number of outstanding requests to C<$nreqs>. If you
		302	try to queue up more than this number of requests, the caller will block until
		303	some requests have been handled.
		304
		305	The default is very large, so normally there is no practical limit. If you
		306	queue up many requests in a loop it it often improves speed if you set
		307	this to a relatively low number, such as C<100>.
		308
		309	Under normal circumstances you don't need to call this function.
		310
		311	=back
		312
225	=cut	313	=cut
226		314
227	# support function to convert a fd into a perl filehandle	315	# support function to convert a fd into a perl filehandle
228	sub _fd2fh {	316	sub _fd2fh {
229	return undef if $_[0] < 0;	317	return undef if $_[0] < 0;
230		318
231	# try to be perl5.6-compatible	319	# try to generate nice filehandles
232	local *AIO_FH;	320	my $sym = "IO::AIO::fd#$_[0]";
233	open AIO_FH, "+<&=$_[0]"	321	local *$sym;
		322
		323	open *$sym, "+<&$_[0]" # usually under any unix
		324	or open *$sym, "<&$_[0]" # cygwin needs this
		325	or open *$sym, ">&$_[0]" # cygwin needs this
234	or return undef;	326	or return undef;
235		327
236	*AIO_FH	328	*$sym
237	}	329	}
238		330
239	min_parallel 4;	331	min_parallel 4;
240		332
241	END {	333	END {
242	max_parallel 0;	334	max_parallel 0;
243	}	335	}
244		336
245	1;	337	1;
246		338
247	=back
248
249	=head1 BUGS
250
251	- could be optimized to use more semaphores instead of filehandles.
252
253	=head1 SEE ALSO	339	=head1 SEE ALSO
254		340
255	L<Coro>, L<Linux::AIO>.	341	L<Coro>, L<Linux::AIO>.
256		342
257	=head1 AUTHOR	343	=head1 AUTHOR

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.3 by root, Sun Jul 10 20:07:11 2005 UTC vs. Revision 1.26 by root, Sun Aug 7 03:34:07 2005 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.3 by root, Sun Jul 10 20:07:11 2005 UTC vs.
Revision 1.26 by root, Sun Aug 7 03:34:07 2005 UTC