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

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.1 by root, Sun Jul 10 17:07:44 2005 UTC vs.
Revision 1.22 by root, Wed Jul 20 21:55:27 2005 UTC

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

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.1 by root, Sun Jul 10 17:07:44 2005 UTC vs. Revision 1.22 by root, Wed Jul 20 21:55:27 2005 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.1 by root, Sun Jul 10 17:07:44 2005 UTC vs.
Revision 1.22 by root, Wed Jul 20 21:55:27 2005 UTC