… | |
… | |
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.6; |
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_readdir 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 | } |
… | |
… | |
88 | syscall has been executed asynchronously. |
88 | syscall has been executed asynchronously. |
89 | |
89 | |
90 | All functions expecting a filehandle keep a copy of the filehandle |
90 | All functions expecting a filehandle keep a copy of the filehandle |
91 | internally until the request has finished. |
91 | internally until the request has finished. |
92 | |
92 | |
93 | 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 |
94 | 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 |
95 | working directory could have changed. Alternatively, you can make sure |
95 | request is being executed, the current working directory could have |
96 | 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. |
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 | |
… | |
… | |
142 | Reads or writes C<length> bytes from the specified C<fh> and C<offset> |
150 | 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 |
151 | 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 |
152 | callback without the actual number of bytes read (or -1 on error, just |
145 | like the syscall). |
153 | like the syscall). |
146 | |
154 | |
|
|
155 | The C<$data> scalar I<MUST NOT> be modified in any way while the request |
|
|
156 | is outstanding. Modifying it can result in segfaults or WW3 (if the |
|
|
157 | necessary/optional hardware is installed). |
|
|
158 | |
147 | Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at |
159 | Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at |
148 | offset C<0> within the scalar: |
160 | offset C<0> within the scalar: |
149 | |
161 | |
150 | aio_read $fh, 7, 15, $buffer, 0, sub { |
162 | aio_read $fh, 7, 15, $buffer, 0, sub { |
151 | $_[0] > 0 or die "read error: $!"; |
163 | $_[0] > 0 or die "read error: $!"; |
152 | print "read $_[0] bytes: <$buffer>\n"; |
164 | print "read $_[0] bytes: <$buffer>\n"; |
153 | }; |
165 | }; |
154 | |
166 | |
|
|
167 | =item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback |
|
|
168 | |
|
|
169 | Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts |
|
|
170 | reading at byte offset C<$in_offset>, and starts writing at the current |
|
|
171 | file offset of C<$out_fh>. Because of that, it is not safe to issue more |
|
|
172 | than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each |
|
|
173 | other. |
|
|
174 | |
|
|
175 | This call tries to make use of a native C<sendfile> syscall to provide |
|
|
176 | zero-copy operation. For this to work, C<$out_fh> should refer to a |
|
|
177 | socket, and C<$in_fh> should refer to mmap'able file. |
|
|
178 | |
|
|
179 | If the native sendfile call fails or is not implemented, it will be |
|
|
180 | emulated, so you can call C<aio_sendfile> on any type of filehandle |
|
|
181 | regardless of the limitations of the operating system. |
|
|
182 | |
|
|
183 | Please note, however, that C<aio_sendfile> can read more bytes from |
|
|
184 | C<$in_fh> than are written, and there is no way to find out how many |
|
|
185 | bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only |
|
|
186 | provides the number of bytes written to C<$out_fh>. Only if the result |
|
|
187 | value equals C<$length> one can assume that C<$length> bytes have been |
|
|
188 | read. |
|
|
189 | |
155 | =item aio_readahead $fh,$offset,$length, $callback |
190 | =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 | |
191 | |
161 | C<aio_readahead> populates the page cache with data from a file so that |
192 | 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> |
193 | 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 |
194 | 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 |
195 | 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 |
196 | 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 |
197 | 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 |
198 | (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. |
199 | file. The current file offset of the file is left unchanged. |
169 | |
200 | |
|
|
201 | If that syscall doesn't exist (likely if your OS isn't Linux) it will be |
|
|
202 | emulated by simply reading the data, which would have a similar effect. |
|
|
203 | |
170 | =item aio_stat $fh_or_path, $callback |
204 | =item aio_stat $fh_or_path, $callback |
171 | |
205 | |
172 | =item aio_lstat $fh, $callback |
206 | =item aio_lstat $fh, $callback |
173 | |
207 | |
174 | Works like perl's C<stat> or C<lstat> in void context. The callback will |
208 | Works like perl's C<stat> or C<lstat> in void context. The callback will |
… | |
… | |
192 | =item aio_unlink $pathname, $callback |
226 | =item aio_unlink $pathname, $callback |
193 | |
227 | |
194 | Asynchronously unlink (delete) a file and call the callback with the |
228 | Asynchronously unlink (delete) a file and call the callback with the |
195 | result code. |
229 | result code. |
196 | |
230 | |
|
|
231 | =item aio_rmdir $pathname, $callback |
|
|
232 | |
|
|
233 | Asynchronously rmdir (delete) a directory and call the callback with the |
|
|
234 | result code. |
|
|
235 | |
|
|
236 | =item aio_readdir $pathname $callback |
|
|
237 | |
|
|
238 | Unlike the POSIX call of the same name, C<aio_readdir> reads an entire |
|
|
239 | directory (i.e. opendir + readdir + closedir). The entries will not be |
|
|
240 | sorted, and will B<NOT> include the C<.> and C<..> entries. |
|
|
241 | |
|
|
242 | The callback a single argument which is either C<undef> or an array-ref |
|
|
243 | with the filenames. |
|
|
244 | |
197 | =item aio_fsync $fh, $callback |
245 | =item aio_fsync $fh, $callback |
198 | |
246 | |
199 | Asynchronously call fsync on the given filehandle and call the callback |
247 | Asynchronously call fsync on the given filehandle and call the callback |
200 | with the fsync result code. |
248 | with the fsync result code. |
201 | |
249 | |
202 | =item aio_fdatasync $fh, $callback |
250 | =item aio_fdatasync $fh, $callback |
203 | |
251 | |
204 | Asynchronously call fdatasync on the given filehandle and call the |
252 | Asynchronously call fdatasync on the given filehandle and call the |
205 | callback with the fdatasync result code. Might set C<$!> to C<ENOSYS> if |
253 | callback with the fdatasync result code. |
206 | C<fdatasync> is not available. |
254 | |
|
|
255 | If this call isn't available because your OS lacks it or it couldn't be |
|
|
256 | detected, it will be emulated by calling C<fsync> instead. |
207 | |
257 | |
208 | =back |
258 | =back |
209 | |
259 | |
210 | =head2 SUPPORT FUNCTIONS |
260 | =head2 SUPPORT FUNCTIONS |
211 | |
261 | |
… | |
… | |
269 | IO::AIO::poll_wait, IO::AIO::poll_cb |
319 | IO::AIO::poll_wait, IO::AIO::poll_cb |
270 | if IO::AIO::nreqs; |
320 | if IO::AIO::nreqs; |
271 | |
321 | |
272 | =item IO::AIO::min_parallel $nthreads |
322 | =item IO::AIO::min_parallel $nthreads |
273 | |
323 | |
274 | Set the minimum number of AIO threads to C<$nthreads>. The default is |
324 | Set the minimum number of AIO threads to C<$nthreads>. The current default |
275 | C<1>, which means a single asynchronous operation can be done at one time |
325 | is C<4>, which means four asynchronous operations can be done at one time |
276 | (the number of outstanding operations, however, is unlimited). |
326 | (the number of outstanding operations, however, is unlimited). |
|
|
327 | |
|
|
328 | IO::AIO starts threads only on demand, when an AIO request is queued and |
|
|
329 | no free thread exists. |
277 | |
330 | |
278 | It is recommended to keep the number of threads low, as some Linux |
331 | It is recommended to keep the number of threads low, as some Linux |
279 | kernel versions will scale negatively with the number of threads (higher |
332 | kernel versions will scale negatively with the number of threads (higher |
280 | parallelity => MUCH higher latency). With current Linux 2.6 versions, 4-32 |
333 | parallelity => MUCH higher latency). With current Linux 2.6 versions, 4-32 |
281 | threads should be fine. |
334 | threads should be fine. |
282 | |
335 | |
283 | Under normal circumstances you don't need to call this function, as this |
336 | Under most circumstances you don't need to call this function, as the |
284 | module automatically starts some threads (the exact number might change, |
337 | module selects a default that is suitable for low to moderate load. |
285 | and is currently 4). |
|
|
286 | |
338 | |
287 | =item IO::AIO::max_parallel $nthreads |
339 | =item IO::AIO::max_parallel $nthreads |
288 | |
340 | |
289 | Sets the maximum number of AIO threads to C<$nthreads>. If more than |
341 | Sets the maximum number of AIO threads to C<$nthreads>. If more than the |
290 | the specified number of threads are currently running, kill them. This |
342 | specified number of threads are currently running, this function kills |
291 | function blocks until the limit is reached. |
343 | them. This function blocks until the limit is reached. |
|
|
344 | |
|
|
345 | While C<$nthreads> are zero, aio requests get queued but not executed |
|
|
346 | until the number of threads has been increased again. |
292 | |
347 | |
293 | This module automatically runs C<max_parallel 0> at program end, to ensure |
348 | This module automatically runs C<max_parallel 0> at program end, to ensure |
294 | that all threads are killed and that there are no outstanding requests. |
349 | that all threads are killed and that there are no outstanding requests. |
295 | |
350 | |
296 | Under normal circumstances you don't need to call this function. |
351 | Under normal circumstances you don't need to call this function. |
… | |
… | |
300 | Sets the maximum number of outstanding requests to C<$nreqs>. If you |
355 | Sets the maximum number of outstanding requests to C<$nreqs>. If you |
301 | try to queue up more than this number of requests, the caller will block until |
356 | try to queue up more than this number of requests, the caller will block until |
302 | some requests have been handled. |
357 | some requests have been handled. |
303 | |
358 | |
304 | The default is very large, so normally there is no practical limit. If you |
359 | The default is very large, so normally there is no practical limit. If you |
305 | queue up many requests in a loop it it often improves speed if you set |
360 | queue up many requests in a loop it often improves speed if you set |
306 | this to a relatively low number, such as C<100>. |
361 | this to a relatively low number, such as C<100>. |
307 | |
362 | |
308 | Under normal circumstances you don't need to call this function. |
363 | Under normal circumstances you don't need to call this function. |
309 | |
364 | |
310 | =back |
365 | =back |
… | |
… | |
317 | |
372 | |
318 | # try to generate nice filehandles |
373 | # try to generate nice filehandles |
319 | my $sym = "IO::AIO::fd#$_[0]"; |
374 | my $sym = "IO::AIO::fd#$_[0]"; |
320 | local *$sym; |
375 | local *$sym; |
321 | |
376 | |
322 | open *$sym, "+<&$_[0]" # usually under any unix |
377 | open *$sym, "+<&=$_[0]" # usually works under any unix |
323 | or open *$sym, "<&$_[0]" # cygwin needs this |
378 | or open *$sym, "<&=$_[0]" # cygwin needs this |
324 | or open *$sym, ">&$_[0]" # cygwin needs this |
379 | or open *$sym, ">&=$_[0]" # or this |
325 | or return undef; |
380 | or return undef; |
326 | |
381 | |
327 | *$sym |
382 | *$sym |
328 | } |
383 | } |
329 | |
384 | |
… | |
… | |
333 | max_parallel 0; |
388 | max_parallel 0; |
334 | } |
389 | } |
335 | |
390 | |
336 | 1; |
391 | 1; |
337 | |
392 | |
|
|
393 | =head2 FORK BEHAVIOUR |
|
|
394 | |
|
|
395 | Before the fork, IO::AIO enters a quiescent state where no requests |
|
|
396 | can be added in other threads and no results will be processed. After |
|
|
397 | the fork the parent simply leaves the quiescent state and continues |
|
|
398 | request/result processing, while the child clears the request/result |
|
|
399 | queue (so the requests started before the fork will only be handled in |
|
|
400 | the parent). Threats will be started on demand until the limit ste in the |
|
|
401 | parent process has been reached again. |
|
|
402 | |
338 | =head1 SEE ALSO |
403 | =head1 SEE ALSO |
339 | |
404 | |
340 | L<Coro>, L<Linux::AIO>. |
405 | L<Coro>, L<Linux::AIO>. |
341 | |
406 | |
342 | =head1 AUTHOR |
407 | =head1 AUTHOR |