ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/IO-AIO/AIO.pm
(Generate patch)

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.21 by root, Wed Jul 13 00:13:09 2005 UTC vs.
Revision 1.27 by root, Tue Aug 16 22:22:18 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
48not well-supported (Linux doesn't allow them on normal files currently, 48not well-supported (Linux doesn't allow them on normal files currently,
49for example), and they would only support aio_read and aio_write, so the 49for example), and they would only support aio_read and aio_write, so the
50remaining functionality would have to be implemented using threads anyway. 50remaining functionality would have to be implemented using threads anyway.
51 51
52Although the module will work with in the presence of other threads, it is 52Although the module will work with in the presence of other threads, it is
53currently not reentrant, so use appropriate locking yourself. 53currently not reentrant, so use appropriate locking yourself, always call
54C<poll_cb> from within the same thread, or never call C<poll_cb> (or other
55C<aio_> functions) recursively.
54 56
55=cut 57=cut
56 58
57package IO::AIO; 59package IO::AIO;
58 60
61no warnings;
62
59use base 'Exporter'; 63use base 'Exporter';
60 64
61use Fcntl (); 65use Fcntl ();
62 66
63BEGIN { 67BEGIN {
64 $VERSION = 0.9; 68 $VERSION = 1.1;
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}
81which must be a code reference. This code reference will get called with 85which must be a code reference. This code reference will get called with
82the syscall return code (e.g. most syscalls return C<-1> on error, unlike 86the syscall return code (e.g. most syscalls return C<-1> on error, unlike
83perl, which usually delivers "false") as it's sole argument when the given 87perl, which usually delivers "false") as it's sole argument when the given
84syscall has been executed asynchronously. 88syscall has been executed asynchronously.
85 89
86All functions that expect a filehandle will also accept a file descriptor. 90All functions expecting a filehandle keep a copy of the filehandle
91internally until the request has finished.
87 92
88The filenames you pass to these routines I<must> be absolute. The reason 93The filenames you pass to these routines I<must> be absolute. The reason
89for this is that at the time the request is being executed, the current 94for this is that at the time the request is being executed, the current
90working directory could have changed. Alternatively, you can make sure 95working directory could have changed. Alternatively, you can make sure
91that you never change the current working directory. 96that you never change the current working directory.
147 print "read $_[0] bytes: <$buffer>\n"; 152 print "read $_[0] bytes: <$buffer>\n";
148 }; 153 };
149 154
150=item aio_readahead $fh,$offset,$length, $callback 155=item aio_readahead $fh,$offset,$length, $callback
151 156
152Asynchronously reads the specified byte range into the page cache, using
153the C<readahead> syscall. If that syscall doesn't exist (likely if your OS
154isn't Linux) the status will be C<-1> and C<$!> is set to C<ENOSYS>.
155
156C<aio_readahead> populates the page cache with data from a file so that 157C<aio_readahead> populates the page cache with data from a file so that
157subsequent reads from that file will not block on disk I/O. The C<$offset> 158subsequent reads from that file will not block on disk I/O. The C<$offset>
158argument specifies the starting point from which data is to be read and 159argument specifies the starting point from which data is to be read and
159C<$length> specifies the number of bytes to be read. I/O is performed in 160C<$length> specifies the number of bytes to be read. I/O is performed in
160whole pages, so that offset is effectively rounded down to a page boundary 161whole pages, so that offset is effectively rounded down to a page boundary
161and bytes are read up to the next page boundary greater than or equal to 162and 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 163(off-set+length). C<aio_readahead> does not read beyond the end of the
163file. The current file offset of the file is left unchanged. 164file. The current file offset of the file is left unchanged.
164 165
166If that syscall doesn't exist (likely if your OS isn't Linux) it will be
167emulated by simply reading the data, which would have a similar effect.
168
165=item aio_stat $fh_or_path, $callback 169=item aio_stat $fh_or_path, $callback
166 170
167=item aio_lstat $fh, $callback 171=item aio_lstat $fh, $callback
168 172
169Works like perl's C<stat> or C<lstat> in void context. The callback will 173Works like perl's C<stat> or C<lstat> in void context. The callback will
187=item aio_unlink $pathname, $callback 191=item aio_unlink $pathname, $callback
188 192
189Asynchronously unlink (delete) a file and call the callback with the 193Asynchronously unlink (delete) a file and call the callback with the
190result code. 194result code.
191 195
196=item aio_rmdir $pathname, $callback
197
198Asynchronously rmdir (delete) a directory and call the callback with the
199result code.
200
192=item aio_fsync $fh, $callback 201=item aio_fsync $fh, $callback
193 202
194Asynchronously call fsync on the given filehandle and call the callback 203Asynchronously call fsync on the given filehandle and call the callback
195with the fsync result code. 204with the fsync result code.
196 205
197=item aio_fdatasync $fh, $callback 206=item aio_fdatasync $fh, $callback
198 207
199Asynchronously call fdatasync on the given filehandle and call the 208Asynchronously call fdatasync on the given filehandle and call the
200callback with the fdatasync result code. Might set C<$!> to C<ENOSYS> if 209callback with the fdatasync result code.
201C<fdatasync> is not available. 210
211If this call isn't available because your OS lacks it or it couldn't be
212detected, it will be emulated by calling C<fsync> instead.
202 213
203=back 214=back
204 215
205=head2 SUPPORT FUNCTIONS 216=head2 SUPPORT FUNCTIONS
206 217
308 319
309# support function to convert a fd into a perl filehandle 320# support function to convert a fd into a perl filehandle
310sub _fd2fh { 321sub _fd2fh {
311 return undef if $_[0] < 0; 322 return undef if $_[0] < 0;
312 323
313 # try to be perl5.6-compatible 324 # try to generate nice filehandles
314 local *AIO_FH; 325 my $sym = "IO::AIO::fd#$_[0]";
315 open AIO_FH, "+<&=$_[0]" 326 local *$sym;
327
328 open *$sym, "+<&=$_[0]" # usually works under any unix
329 or open *$sym, "<&=$_[0]" # cygwin needs this
330 or open *$sym, ">&=$_[0]" # or this
316 or return undef; 331 or return undef;
317 332
318 *AIO_FH 333 *$sym
319} 334}
320 335
321min_parallel 4; 336min_parallel 4;
322 337
323END { 338END {
324 max_parallel 0; 339 max_parallel 0;
325} 340}
326 341
3271; 3421;
328 343
344=head2 FORK BEHAVIOUR
345
346IO::AIO handles all outstanding AIO requests before the fork, destroys all
347AIO threads, and recreates them in both the parent and the child after the
348fork.
349
350
329=head1 SEE ALSO 351=head1 SEE ALSO
330 352
331L<Coro>, L<Linux::AIO>. 353L<Coro>, L<Linux::AIO>.
332 354
333=head1 AUTHOR 355=head1 AUTHOR

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines