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.24 by root, Sun Jul 31 18:45:48 2005 UTC vs.
Revision 1.30 by root, Wed Aug 17 04:47:38 2005 UTC

63use base 'Exporter'; 63use base 'Exporter';
64 64
65use Fcntl (); 65use Fcntl ();
66 66
67BEGIN { 67BEGIN {
68 $VERSION = 1.1; 68 $VERSION = 1.2;
69 69
70 @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
71 aio_fsync aio_fdatasync aio_readahead); 71 aio_rmdir aio_symlink aio_fsync aio_fdatasync aio_readahead);
72 @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);
73 73
74 require XSLoader; 74 require XSLoader;
75 XSLoader::load IO::AIO, $VERSION; 75 XSLoader::load IO::AIO, $VERSION;
76} 76}
88syscall has been executed asynchronously. 88syscall has been executed asynchronously.
89 89
90All functions expecting a filehandle keep a copy of the filehandle 90All functions expecting a filehandle keep a copy of the filehandle
91internally until the request has finished. 91internally until the request has finished.
92 92
93The filenames you pass to these routines I<must> be absolute. The reason 93The pathnames you pass to these routines I<must> be absolute and
94for this is that at the time the request is being executed, the current 94encoded in byte form. The reason for the former is that at the time the
95working directory could have changed. Alternatively, you can make sure 95request is being executed, the current working directory could have
96that you never change the current working directory. 96changed. Alternatively, you can make sure that you never change the
97current working directory.
98
99To encode pathnames to byte form, either make sure you either: a)
100always pass in filenames you got from outside (command line, readdir
101etc.), b) are ASCII or ISO 8859-1, c) use the Encode module and encode
102your pathnames to the locale (or other) encoding in effect in the user
103environment, d) use Glib::filename_from_unicode on unicode filenames or e)
104use something else.
97 105
98=over 4 106=over 4
99 107
100=item aio_open $pathname, $flags, $mode, $callback 108=item aio_open $pathname, $flags, $mode, $callback
101 109
152 print "read $_[0] bytes: <$buffer>\n"; 160 print "read $_[0] bytes: <$buffer>\n";
153 }; 161 };
154 162
155=item aio_readahead $fh,$offset,$length, $callback 163=item aio_readahead $fh,$offset,$length, $callback
156 164
157Asynchronously reads the specified byte range into the page cache, using
158the C<readahead> syscall. If that syscall doesn't exist (likely if your OS
159isn't Linux) the status will be C<-1> and C<$!> is set to C<ENOSYS>.
160
161C<aio_readahead> populates the page cache with data from a file so that 165C<aio_readahead> populates the page cache with data from a file so that
162subsequent reads from that file will not block on disk I/O. The C<$offset> 166subsequent reads from that file will not block on disk I/O. The C<$offset>
163argument specifies the starting point from which data is to be read and 167argument specifies the starting point from which data is to be read and
164C<$length> specifies the number of bytes to be read. I/O is performed in 168C<$length> specifies the number of bytes to be read. I/O is performed in
165whole pages, so that offset is effectively rounded down to a page boundary 169whole pages, so that offset is effectively rounded down to a page boundary
166and bytes are read up to the next page boundary greater than or equal to 170and bytes are read up to the next page boundary greater than or equal to
167(off-set+length). C<aio_readahead> does not read beyond the end of the 171(off-set+length). C<aio_readahead> does not read beyond the end of the
168file. The current file offset of the file is left unchanged. 172file. The current file offset of the file is left unchanged.
169 173
174If that syscall doesn't exist (likely if your OS isn't Linux) it will be
175emulated by simply reading the data, which would have a similar effect.
176
170=item aio_stat $fh_or_path, $callback 177=item aio_stat $fh_or_path, $callback
171 178
172=item aio_lstat $fh, $callback 179=item aio_lstat $fh, $callback
173 180
174Works like perl's C<stat> or C<lstat> in void context. The callback will 181Works like perl's C<stat> or C<lstat> in void context. The callback will
192=item aio_unlink $pathname, $callback 199=item aio_unlink $pathname, $callback
193 200
194Asynchronously unlink (delete) a file and call the callback with the 201Asynchronously unlink (delete) a file and call the callback with the
195result code. 202result code.
196 203
204=item aio_rmdir $pathname, $callback
205
206Asynchronously rmdir (delete) a directory and call the callback with the
207result code.
208
197=item aio_fsync $fh, $callback 209=item aio_fsync $fh, $callback
198 210
199Asynchronously call fsync on the given filehandle and call the callback 211Asynchronously call fsync on the given filehandle and call the callback
200with the fsync result code. 212with the fsync result code.
201 213
202=item aio_fdatasync $fh, $callback 214=item aio_fdatasync $fh, $callback
203 215
204Asynchronously call fdatasync on the given filehandle and call the 216Asynchronously call fdatasync on the given filehandle and call the
205callback with the fdatasync result code. Might set C<$!> to C<ENOSYS> if 217callback with the fdatasync result code.
206C<fdatasync> is not available. 218
219If this call isn't available because your OS lacks it or it couldn't be
220detected, it will be emulated by calling C<fsync> instead.
207 221
208=back 222=back
209 223
210=head2 SUPPORT FUNCTIONS 224=head2 SUPPORT FUNCTIONS
211 225
316 return undef if $_[0] < 0; 330 return undef if $_[0] < 0;
317 331
318 # try to generate nice filehandles 332 # try to generate nice filehandles
319 my $sym = "IO::AIO::fd#$_[0]"; 333 my $sym = "IO::AIO::fd#$_[0]";
320 local *$sym; 334 local *$sym;
321 open *$sym, "+<&=$_[0]" 335
336 open *$sym, "+<&=$_[0]" # usually works under any unix
337 or open *$sym, "<&=$_[0]" # cygwin needs this
338 or open *$sym, ">&=$_[0]" # or this
322 or return undef; 339 or return undef;
323 340
324 *$sym 341 *$sym
325} 342}
326 343
330 max_parallel 0; 347 max_parallel 0;
331} 348}
332 349
3331; 3501;
334 351
352=head2 FORK BEHAVIOUR
353
354Before the fork IO::AIO first handles all outstanding requests - if other
355threads add requests during this period, this time is prolonged. It then
356enters a quiescent state where no requests can be added in other threads
357and no results will be processed. After the fork the parent simply leaves
358the quiescent state and continues request processing, while the child
359starts the same number of threads as were in use by the parent.
360
335=head1 SEE ALSO 361=head1 SEE ALSO
336 362
337L<Coro>, L<Linux::AIO>. 363L<Coro>, L<Linux::AIO>.
338 364
339=head1 AUTHOR 365=head1 AUTHOR

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines