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.22 by root, Wed Jul 20 21:55:27 2005 UTC vs.
Revision 1.27 by root, Tue Aug 16 22:22:18 2005 UTC

56 56
57=cut 57=cut
58 58
59package IO::AIO; 59package IO::AIO;
60 60
61no warnings;
62
61use base 'Exporter'; 63use base 'Exporter';
62 64
63use Fcntl (); 65use Fcntl ();
64 66
65BEGIN { 67BEGIN {
66 $VERSION = 0.9; 68 $VERSION = 1.1;
67 69
68 @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
69 aio_fsync aio_fdatasync aio_readahead); 71 aio_rmdir aio_symlink aio_fsync aio_fdatasync aio_readahead);
70 @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);
71 73
72 require XSLoader; 74 require XSLoader;
73 XSLoader::load IO::AIO, $VERSION; 75 XSLoader::load IO::AIO, $VERSION;
74} 76}
83which 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
84the 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
85perl, 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
86syscall has been executed asynchronously. 88syscall has been executed asynchronously.
87 89
88All 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.
89 92
90The 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
91for 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
92working directory could have changed. Alternatively, you can make sure 95working directory could have changed. Alternatively, you can make sure
93that you never change the current working directory. 96that you never change the current working directory.
149 print "read $_[0] bytes: <$buffer>\n"; 152 print "read $_[0] bytes: <$buffer>\n";
150 }; 153 };
151 154
152=item aio_readahead $fh,$offset,$length, $callback 155=item aio_readahead $fh,$offset,$length, $callback
153 156
154Asynchronously reads the specified byte range into the page cache, using
155the C<readahead> syscall. If that syscall doesn't exist (likely if your OS
156isn't Linux) the status will be C<-1> and C<$!> is set to C<ENOSYS>.
157
158C<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
159subsequent 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>
160argument 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
161C<$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
162whole 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
163and 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
164(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
165file. The current file offset of the file is left unchanged. 164file. The current file offset of the file is left unchanged.
166 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
167=item aio_stat $fh_or_path, $callback 169=item aio_stat $fh_or_path, $callback
168 170
169=item aio_lstat $fh, $callback 171=item aio_lstat $fh, $callback
170 172
171Works 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
189=item aio_unlink $pathname, $callback 191=item aio_unlink $pathname, $callback
190 192
191Asynchronously unlink (delete) a file and call the callback with the 193Asynchronously unlink (delete) a file and call the callback with the
192result code. 194result code.
193 195
196=item aio_rmdir $pathname, $callback
197
198Asynchronously rmdir (delete) a directory and call the callback with the
199result code.
200
194=item aio_fsync $fh, $callback 201=item aio_fsync $fh, $callback
195 202
196Asynchronously call fsync on the given filehandle and call the callback 203Asynchronously call fsync on the given filehandle and call the callback
197with the fsync result code. 204with the fsync result code.
198 205
199=item aio_fdatasync $fh, $callback 206=item aio_fdatasync $fh, $callback
200 207
201Asynchronously call fdatasync on the given filehandle and call the 208Asynchronously call fdatasync on the given filehandle and call the
202callback with the fdatasync result code. Might set C<$!> to C<ENOSYS> if 209callback with the fdatasync result code.
203C<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.
204 213
205=back 214=back
206 215
207=head2 SUPPORT FUNCTIONS 216=head2 SUPPORT FUNCTIONS
208 217
310 319
311# support function to convert a fd into a perl filehandle 320# support function to convert a fd into a perl filehandle
312sub _fd2fh { 321sub _fd2fh {
313 return undef if $_[0] < 0; 322 return undef if $_[0] < 0;
314 323
315 # try to be perl5.6-compatible 324 # try to generate nice filehandles
316 local *AIO_FH; 325 my $sym = "IO::AIO::fd#$_[0]";
317 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
318 or return undef; 331 or return undef;
319 332
320 *AIO_FH 333 *$sym
321} 334}
322 335
323min_parallel 4; 336min_parallel 4;
324 337
325END { 338END {
326 max_parallel 0; 339 max_parallel 0;
327} 340}
328 341
3291; 3421;
330 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
331=head1 SEE ALSO 351=head1 SEE ALSO
332 352
333L<Coro>, L<Linux::AIO>. 353L<Coro>, L<Linux::AIO>.
334 354
335=head1 AUTHOR 355=head1 AUTHOR

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines