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