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