… | |
… | |
5 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
6 | |
6 | |
7 | use IO::AIO; |
7 | use IO::AIO; |
8 | |
8 | |
9 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
9 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
10 | my ($fh) = @_; |
10 | my $fh = shift |
|
|
11 | or die "/etc/passwd: $!"; |
11 | ... |
12 | ... |
12 | }; |
13 | }; |
13 | |
14 | |
14 | aio_unlink "/tmp/file", sub { }; |
15 | aio_unlink "/tmp/file", sub { }; |
15 | |
16 | |
… | |
… | |
25 | $req->cancel; # cancel request if still in queue |
26 | $req->cancel; # cancel request if still in queue |
26 | |
27 | |
27 | my $grp = aio_group sub { print "all stats done\n" }; |
28 | my $grp = aio_group sub { print "all stats done\n" }; |
28 | add $grp aio_stat "..." for ...; |
29 | add $grp aio_stat "..." for ...; |
29 | |
30 | |
30 | # AnyEvent integration |
31 | # AnyEvent integration (EV, Event, Glib, Tk, urxvt, pureperl...) |
31 | open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!"; |
32 | open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!"; |
32 | my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb }); |
33 | my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb }); |
|
|
34 | |
|
|
35 | # EV integration |
|
|
36 | my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; |
33 | |
37 | |
34 | # Event integration |
38 | # Event integration |
35 | Event->io (fd => IO::AIO::poll_fileno, |
39 | Event->io (fd => IO::AIO::poll_fileno, |
36 | poll => 'r', |
40 | poll => 'r', |
37 | cb => \&IO::AIO::poll_cb); |
41 | cb => \&IO::AIO::poll_cb); |
… | |
… | |
61 | etc.), but can also be used to easily do operations in parallel that are |
65 | etc.), but can also be used to easily do operations in parallel that are |
62 | normally done sequentially, e.g. stat'ing many files, which is much faster |
66 | normally done sequentially, e.g. stat'ing many files, which is much faster |
63 | on a RAID volume or over NFS when you do a number of stat operations |
67 | on a RAID volume or over NFS when you do a number of stat operations |
64 | concurrently. |
68 | concurrently. |
65 | |
69 | |
66 | While this works on all types of file descriptors (for example sockets), |
70 | While most of this works on all types of file descriptors (for |
67 | using these functions on file descriptors that support nonblocking |
71 | example sockets), using these functions on file descriptors that |
68 | operation (again, sockets, pipes etc.) is very inefficient. Use an event |
72 | support nonblocking operation (again, sockets, pipes etc.) is very |
69 | loop for that (such as the L<Event|Event> module): IO::AIO will naturally |
73 | inefficient. Use an event loop for that (such as the L<Event|Event> |
70 | fit into such an event loop itself. |
74 | module): IO::AIO will naturally fit into such an event loop itself. |
71 | |
75 | |
72 | In this version, a number of threads are started that execute your |
76 | In this version, a number of threads are started that execute your |
73 | requests and signal their completion. You don't need thread support |
77 | requests and signal their completion. You don't need thread support |
74 | in perl, and the threads created by this module will not be visible |
78 | in perl, and the threads created by this module will not be visible |
75 | to perl. In the future, this module might make use of the native aio |
79 | to perl. In the future, this module might make use of the native aio |
… | |
… | |
77 | not well-supported or restricted (GNU/Linux doesn't allow them on normal |
81 | not well-supported or restricted (GNU/Linux doesn't allow them on normal |
78 | files currently, for example), and they would only support aio_read and |
82 | files currently, for example), and they would only support aio_read and |
79 | aio_write, so the remaining functionality would have to be implemented |
83 | aio_write, so the remaining functionality would have to be implemented |
80 | using threads anyway. |
84 | using threads anyway. |
81 | |
85 | |
82 | Although the module will work with in the presence of other (Perl-) |
86 | Although the module will work in the presence of other (Perl-) threads, |
83 | threads, it is currently not reentrant in any way, so use appropriate |
87 | it is currently not reentrant in any way, so use appropriate locking |
84 | locking yourself, always call C<poll_cb> from within the same thread, or |
88 | yourself, always call C<poll_cb> from within the same thread, or never |
85 | never call C<poll_cb> (or other C<aio_> functions) recursively. |
89 | call C<poll_cb> (or other C<aio_> functions) recursively. |
86 | |
90 | |
87 | =head2 EXAMPLE |
91 | =head2 EXAMPLE |
88 | |
92 | |
89 | This is a simple example that uses the Event module and loads |
93 | This is a simple example that uses the Event module and loads |
90 | F</etc/passwd> asynchronously: |
94 | F</etc/passwd> asynchronously: |
… | |
… | |
98 | poll => 'r', |
102 | poll => 'r', |
99 | cb => \&IO::AIO::poll_cb); |
103 | cb => \&IO::AIO::poll_cb); |
100 | |
104 | |
101 | # queue the request to open /etc/passwd |
105 | # queue the request to open /etc/passwd |
102 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
106 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
103 | my $fh = $_[0] |
107 | my $fh = shift |
104 | or die "error while opening: $!"; |
108 | or die "error while opening: $!"; |
105 | |
109 | |
106 | # stat'ing filehandles is generally non-blocking |
110 | # stat'ing filehandles is generally non-blocking |
107 | my $size = -s $fh; |
111 | my $size = -s $fh; |
108 | |
112 | |
… | |
… | |
182 | |
186 | |
183 | =cut |
187 | =cut |
184 | |
188 | |
185 | package IO::AIO; |
189 | package IO::AIO; |
186 | |
190 | |
|
|
191 | use Carp (); |
|
|
192 | |
187 | no warnings; |
193 | no warnings; |
188 | use strict 'vars'; |
194 | use strict 'vars'; |
189 | |
195 | |
190 | use base 'Exporter'; |
196 | use base 'Exporter'; |
191 | |
197 | |
192 | BEGIN { |
198 | BEGIN { |
193 | our $VERSION = '2.1'; |
199 | our $VERSION = '2.6'; |
194 | |
200 | |
195 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat |
201 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close |
196 | aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink |
202 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir |
197 | aio_fsync aio_fdatasync aio_readahead aio_rename aio_link aio_move |
203 | aio_scandir aio_symlink aio_readlink aio_sync aio_fsync |
198 | aio_copy aio_group aio_nop aio_mknod); |
204 | aio_fdatasync aio_pathsync aio_readahead |
|
|
205 | aio_rename aio_link aio_move aio_copy aio_group |
|
|
206 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
|
|
207 | aio_chmod aio_utime aio_truncate); |
|
|
208 | |
199 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
209 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block)); |
200 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
210 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
201 | min_parallel max_parallel max_idle |
211 | min_parallel max_parallel max_idle |
202 | nreqs nready npending nthreads |
212 | nreqs nready npending nthreads |
203 | max_poll_time max_poll_reqs); |
213 | max_poll_time max_poll_reqs); |
204 | |
214 | |
… | |
… | |
269 | aio_read $_[0], ..., sub { |
279 | aio_read $_[0], ..., sub { |
270 | ... |
280 | ... |
271 | }; |
281 | }; |
272 | }; |
282 | }; |
273 | |
283 | |
|
|
284 | |
274 | =item aioreq_nice $pri_adjust |
285 | =item aioreq_nice $pri_adjust |
275 | |
286 | |
276 | Similar to C<aioreq_pri>, but subtracts the given value from the current |
287 | Similar to C<aioreq_pri>, but subtracts the given value from the current |
277 | priority, so the effect is cumulative. |
288 | priority, so the effect is cumulative. |
|
|
289 | |
278 | |
290 | |
279 | =item aio_open $pathname, $flags, $mode, $callback->($fh) |
291 | =item aio_open $pathname, $flags, $mode, $callback->($fh) |
280 | |
292 | |
281 | Asynchronously open or create a file and call the callback with a newly |
293 | Asynchronously open or create a file and call the callback with a newly |
282 | created filehandle for the file. |
294 | created filehandle for the file. |
… | |
… | |
288 | list. They are the same as used by C<sysopen>. |
300 | list. They are the same as used by C<sysopen>. |
289 | |
301 | |
290 | Likewise, C<$mode> specifies the mode of the newly created file, if it |
302 | Likewise, C<$mode> specifies the mode of the newly created file, if it |
291 | didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>, |
303 | didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>, |
292 | except that it is mandatory (i.e. use C<0> if you don't create new files, |
304 | except that it is mandatory (i.e. use C<0> if you don't create new files, |
293 | and C<0666> or C<0777> if you do). |
305 | and C<0666> or C<0777> if you do). Note that the C<$mode> will be modified |
|
|
306 | by the umask in effect then the request is being executed, so better never |
|
|
307 | change the umask. |
294 | |
308 | |
295 | Example: |
309 | Example: |
296 | |
310 | |
297 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
311 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
298 | if ($_[0]) { |
312 | if ($_[0]) { |
… | |
… | |
301 | } else { |
315 | } else { |
302 | die "open failed: $!\n"; |
316 | die "open failed: $!\n"; |
303 | } |
317 | } |
304 | }; |
318 | }; |
305 | |
319 | |
|
|
320 | |
306 | =item aio_close $fh, $callback->($status) |
321 | =item aio_close $fh, $callback->($status) |
307 | |
322 | |
308 | Asynchronously close a file and call the callback with the result |
323 | Asynchronously close a file and call the callback with the result |
309 | code. I<WARNING:> although accepted, you should not pass in a perl |
324 | code. |
310 | filehandle here, as perl will likely close the file descriptor another |
|
|
311 | time when the filehandle is destroyed. Normally, you can safely call perls |
|
|
312 | C<close> or just let filehandles go out of scope. |
|
|
313 | |
325 | |
314 | This is supposed to be a bug in the API, so that might change. It's |
326 | Unfortunately, you can't do this to perl. Perl I<insists> very strongly on |
315 | therefore best to avoid this function. |
327 | closing the file descriptor associated with the filehandle itself. Here is |
|
|
328 | what aio_close will try: |
|
|
329 | |
|
|
330 | 1. dup()licate the fd |
|
|
331 | 2. asynchronously close() the duplicated fd |
|
|
332 | 3. dup()licate the fd once more |
|
|
333 | 4. let perl close() the filehandle |
|
|
334 | 5. asynchronously close the duplicated fd |
|
|
335 | |
|
|
336 | The idea is that the first close() flushes stuff to disk that closing an |
|
|
337 | fd will flush, so when perl closes the fd, nothing much will need to be |
|
|
338 | flushed. The second async. close() will then flush stuff to disk that |
|
|
339 | closing the last fd to the file will flush. |
|
|
340 | |
|
|
341 | Just FYI, SuSv3 has this to say on close: |
|
|
342 | |
|
|
343 | All outstanding record locks owned by the process on the file |
|
|
344 | associated with the file descriptor shall be removed. |
|
|
345 | |
|
|
346 | If fildes refers to a socket, close() shall cause the socket to be |
|
|
347 | destroyed. ... close() shall block for up to the current linger |
|
|
348 | interval until all data is transmitted. |
|
|
349 | [this actually sounds like a specification bug, but who knows] |
|
|
350 | |
|
|
351 | And at least Linux additionally actually flushes stuff on every close, |
|
|
352 | even when the file itself is still open. |
|
|
353 | |
|
|
354 | Sounds enourmously inefficient and complicated? Yes... please show me how |
|
|
355 | to nuke perl's fd out of existence... |
|
|
356 | |
|
|
357 | =cut |
|
|
358 | |
|
|
359 | sub aio_close($;$) { |
|
|
360 | aio_block { |
|
|
361 | my ($fh, $cb) = @_; |
|
|
362 | |
|
|
363 | my $pri = aioreq_pri; |
|
|
364 | my $grp = aio_group $cb; |
|
|
365 | |
|
|
366 | my $fd = fileno $fh; |
|
|
367 | |
|
|
368 | defined $fd or Carp::croak "aio_close called with fd-less filehandle"; |
|
|
369 | |
|
|
370 | # if the dups fail we will simply get EBADF |
|
|
371 | my $fd2 = _dup $fd; |
|
|
372 | aioreq_pri $pri; |
|
|
373 | add $grp _aio_close $fd2, sub { |
|
|
374 | my $fd2 = _dup $fd; |
|
|
375 | close $fh; |
|
|
376 | aioreq_pri $pri; |
|
|
377 | add $grp _aio_close $fd2, sub { |
|
|
378 | $grp->result ($_[0]); |
|
|
379 | }; |
|
|
380 | }; |
|
|
381 | |
|
|
382 | $grp |
|
|
383 | } |
|
|
384 | } |
|
|
385 | |
316 | |
386 | |
317 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
387 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
318 | |
388 | |
319 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
389 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
320 | |
390 | |
321 | Reads or writes C<length> bytes from the specified C<fh> and C<offset> |
391 | Reads or writes C<$length> bytes from the specified C<$fh> and C<$offset> |
322 | into the scalar given by C<data> and offset C<dataoffset> and calls the |
392 | into the scalar given by C<$data> and offset C<$dataoffset> and calls the |
323 | callback without the actual number of bytes read (or -1 on error, just |
393 | callback without the actual number of bytes read (or -1 on error, just |
324 | like the syscall). |
394 | like the syscall). |
325 | |
395 | |
|
|
396 | If C<$offset> is undefined, then the current file descriptor offset will |
|
|
397 | be used (and updated), otherwise the file descriptor offset will not be |
|
|
398 | changed by these calls. |
|
|
399 | |
|
|
400 | If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>. |
|
|
401 | |
|
|
402 | If C<$dataoffset> is less than zero, it will be counted from the end of |
|
|
403 | C<$data>. |
|
|
404 | |
326 | The C<$data> scalar I<MUST NOT> be modified in any way while the request |
405 | The C<$data> scalar I<MUST NOT> be modified in any way while the request |
327 | is outstanding. Modifying it can result in segfaults or WW3 (if the |
406 | is outstanding. Modifying it can result in segfaults or World War III (if |
328 | necessary/optional hardware is installed). |
407 | the necessary/optional hardware is installed). |
329 | |
408 | |
330 | Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at |
409 | Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at |
331 | offset C<0> within the scalar: |
410 | offset C<0> within the scalar: |
332 | |
411 | |
333 | aio_read $fh, 7, 15, $buffer, 0, sub { |
412 | aio_read $fh, 7, 15, $buffer, 0, sub { |
334 | $_[0] > 0 or die "read error: $!"; |
413 | $_[0] > 0 or die "read error: $!"; |
335 | print "read $_[0] bytes: <$buffer>\n"; |
414 | print "read $_[0] bytes: <$buffer>\n"; |
336 | }; |
415 | }; |
|
|
416 | |
337 | |
417 | |
338 | =item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
418 | =item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
339 | |
419 | |
340 | Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts |
420 | Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts |
341 | reading at byte offset C<$in_offset>, and starts writing at the current |
421 | reading at byte offset C<$in_offset>, and starts writing at the current |
… | |
… | |
355 | C<$in_fh> than are written, and there is no way to find out how many |
435 | C<$in_fh> than are written, and there is no way to find out how many |
356 | bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only |
436 | bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only |
357 | provides the number of bytes written to C<$out_fh>. Only if the result |
437 | provides the number of bytes written to C<$out_fh>. Only if the result |
358 | value equals C<$length> one can assume that C<$length> bytes have been |
438 | value equals C<$length> one can assume that C<$length> bytes have been |
359 | read. |
439 | read. |
|
|
440 | |
360 | |
441 | |
361 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
442 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
362 | |
443 | |
363 | C<aio_readahead> populates the page cache with data from a file so that |
444 | C<aio_readahead> populates the page cache with data from a file so that |
364 | subsequent reads from that file will not block on disk I/O. The C<$offset> |
445 | subsequent reads from that file will not block on disk I/O. The C<$offset> |
… | |
… | |
370 | file. The current file offset of the file is left unchanged. |
451 | file. The current file offset of the file is left unchanged. |
371 | |
452 | |
372 | If that syscall doesn't exist (likely if your OS isn't Linux) it will be |
453 | If that syscall doesn't exist (likely if your OS isn't Linux) it will be |
373 | emulated by simply reading the data, which would have a similar effect. |
454 | emulated by simply reading the data, which would have a similar effect. |
374 | |
455 | |
|
|
456 | |
375 | =item aio_stat $fh_or_path, $callback->($status) |
457 | =item aio_stat $fh_or_path, $callback->($status) |
376 | |
458 | |
377 | =item aio_lstat $fh, $callback->($status) |
459 | =item aio_lstat $fh, $callback->($status) |
378 | |
460 | |
379 | Works like perl's C<stat> or C<lstat> in void context. The callback will |
461 | Works like perl's C<stat> or C<lstat> in void context. The callback will |
… | |
… | |
392 | aio_stat "/etc/passwd", sub { |
474 | aio_stat "/etc/passwd", sub { |
393 | $_[0] and die "stat failed: $!"; |
475 | $_[0] and die "stat failed: $!"; |
394 | print "size is ", -s _, "\n"; |
476 | print "size is ", -s _, "\n"; |
395 | }; |
477 | }; |
396 | |
478 | |
|
|
479 | |
|
|
480 | =item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
|
|
481 | |
|
|
482 | Works like perl's C<utime> function (including the special case of $atime |
|
|
483 | and $mtime being undef). Fractional times are supported if the underlying |
|
|
484 | syscalls support them. |
|
|
485 | |
|
|
486 | When called with a pathname, uses utimes(2) if available, otherwise |
|
|
487 | utime(2). If called on a file descriptor, uses futimes(2) if available, |
|
|
488 | otherwise returns ENOSYS, so this is not portable. |
|
|
489 | |
|
|
490 | Examples: |
|
|
491 | |
|
|
492 | # set atime and mtime to current time (basically touch(1)): |
|
|
493 | aio_utime "path", undef, undef; |
|
|
494 | # set atime to current time and mtime to beginning of the epoch: |
|
|
495 | aio_utime "path", time, undef; # undef==0 |
|
|
496 | |
|
|
497 | |
|
|
498 | =item aio_chown $fh_or_path, $uid, $gid, $callback->($status) |
|
|
499 | |
|
|
500 | Works like perl's C<chown> function, except that C<undef> for either $uid |
|
|
501 | or $gid is being interpreted as "do not change" (but -1 can also be used). |
|
|
502 | |
|
|
503 | Examples: |
|
|
504 | |
|
|
505 | # same as "chown root path" in the shell: |
|
|
506 | aio_chown "path", 0, -1; |
|
|
507 | # same as above: |
|
|
508 | aio_chown "path", 0, undef; |
|
|
509 | |
|
|
510 | |
|
|
511 | =item aio_truncate $fh_or_path, $offset, $callback->($status) |
|
|
512 | |
|
|
513 | Works like truncate(2) or ftruncate(2). |
|
|
514 | |
|
|
515 | |
|
|
516 | =item aio_chmod $fh_or_path, $mode, $callback->($status) |
|
|
517 | |
|
|
518 | Works like perl's C<chmod> function. |
|
|
519 | |
|
|
520 | |
397 | =item aio_unlink $pathname, $callback->($status) |
521 | =item aio_unlink $pathname, $callback->($status) |
398 | |
522 | |
399 | Asynchronously unlink (delete) a file and call the callback with the |
523 | Asynchronously unlink (delete) a file and call the callback with the |
400 | result code. |
524 | result code. |
401 | |
525 | |
|
|
526 | |
402 | =item aio_mknod $path, $mode, $dev, $callback->($status) |
527 | =item aio_mknod $path, $mode, $dev, $callback->($status) |
403 | |
528 | |
404 | [EXPERIMENTAL] |
529 | [EXPERIMENTAL] |
405 | |
530 | |
406 | Asynchronously create a device node (or fifo). See mknod(2). |
531 | Asynchronously create a device node (or fifo). See mknod(2). |
407 | |
532 | |
408 | The only (POSIX-) portable way of calling this function is: |
533 | The only (POSIX-) portable way of calling this function is: |
409 | |
534 | |
410 | aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... |
535 | aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... |
|
|
536 | |
411 | |
537 | |
412 | =item aio_link $srcpath, $dstpath, $callback->($status) |
538 | =item aio_link $srcpath, $dstpath, $callback->($status) |
413 | |
539 | |
414 | Asynchronously create a new link to the existing object at C<$srcpath> at |
540 | Asynchronously create a new link to the existing object at C<$srcpath> at |
415 | the path C<$dstpath> and call the callback with the result code. |
541 | the path C<$dstpath> and call the callback with the result code. |
416 | |
542 | |
|
|
543 | |
417 | =item aio_symlink $srcpath, $dstpath, $callback->($status) |
544 | =item aio_symlink $srcpath, $dstpath, $callback->($status) |
418 | |
545 | |
419 | Asynchronously create a new symbolic link to the existing object at C<$srcpath> at |
546 | Asynchronously create a new symbolic link to the existing object at C<$srcpath> at |
420 | the path C<$dstpath> and call the callback with the result code. |
547 | the path C<$dstpath> and call the callback with the result code. |
421 | |
548 | |
|
|
549 | |
|
|
550 | =item aio_readlink $path, $callback->($link) |
|
|
551 | |
|
|
552 | Asynchronously read the symlink specified by C<$path> and pass it to |
|
|
553 | the callback. If an error occurs, nothing or undef gets passed to the |
|
|
554 | callback. |
|
|
555 | |
|
|
556 | |
422 | =item aio_rename $srcpath, $dstpath, $callback->($status) |
557 | =item aio_rename $srcpath, $dstpath, $callback->($status) |
423 | |
558 | |
424 | Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as |
559 | Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as |
425 | rename(2) and call the callback with the result code. |
560 | rename(2) and call the callback with the result code. |
426 | |
561 | |
|
|
562 | |
|
|
563 | =item aio_mkdir $pathname, $mode, $callback->($status) |
|
|
564 | |
|
|
565 | Asynchronously mkdir (create) a directory and call the callback with |
|
|
566 | the result code. C<$mode> will be modified by the umask at the time the |
|
|
567 | request is executed, so do not change your umask. |
|
|
568 | |
|
|
569 | |
427 | =item aio_rmdir $pathname, $callback->($status) |
570 | =item aio_rmdir $pathname, $callback->($status) |
428 | |
571 | |
429 | Asynchronously rmdir (delete) a directory and call the callback with the |
572 | Asynchronously rmdir (delete) a directory and call the callback with the |
430 | result code. |
573 | result code. |
|
|
574 | |
431 | |
575 | |
432 | =item aio_readdir $pathname, $callback->($entries) |
576 | =item aio_readdir $pathname, $callback->($entries) |
433 | |
577 | |
434 | Unlike the POSIX call of the same name, C<aio_readdir> reads an entire |
578 | Unlike the POSIX call of the same name, C<aio_readdir> reads an entire |
435 | directory (i.e. opendir + readdir + closedir). The entries will not be |
579 | directory (i.e. opendir + readdir + closedir). The entries will not be |
436 | sorted, and will B<NOT> include the C<.> and C<..> entries. |
580 | sorted, and will B<NOT> include the C<.> and C<..> entries. |
437 | |
581 | |
438 | The callback a single argument which is either C<undef> or an array-ref |
582 | The callback a single argument which is either C<undef> or an array-ref |
439 | with the filenames. |
583 | with the filenames. |
|
|
584 | |
|
|
585 | |
|
|
586 | =item aio_load $path, $data, $callback->($status) |
|
|
587 | |
|
|
588 | This is a composite request that tries to fully load the given file into |
|
|
589 | memory. Status is the same as with aio_read. |
|
|
590 | |
|
|
591 | =cut |
|
|
592 | |
|
|
593 | sub aio_load($$;$) { |
|
|
594 | aio_block { |
|
|
595 | my ($path, undef, $cb) = @_; |
|
|
596 | my $data = \$_[1]; |
|
|
597 | |
|
|
598 | my $pri = aioreq_pri; |
|
|
599 | my $grp = aio_group $cb; |
|
|
600 | |
|
|
601 | aioreq_pri $pri; |
|
|
602 | add $grp aio_open $path, O_RDONLY, 0, sub { |
|
|
603 | my $fh = shift |
|
|
604 | or return $grp->result (-1); |
|
|
605 | |
|
|
606 | aioreq_pri $pri; |
|
|
607 | add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub { |
|
|
608 | $grp->result ($_[0]); |
|
|
609 | }; |
|
|
610 | }; |
|
|
611 | |
|
|
612 | $grp |
|
|
613 | } |
|
|
614 | } |
440 | |
615 | |
441 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
616 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
442 | |
617 | |
443 | Try to copy the I<file> (directories not supported as either source or |
618 | Try to copy the I<file> (directories not supported as either source or |
444 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
619 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
… | |
… | |
454 | errors are being ignored. |
629 | errors are being ignored. |
455 | |
630 | |
456 | =cut |
631 | =cut |
457 | |
632 | |
458 | sub aio_copy($$;$) { |
633 | sub aio_copy($$;$) { |
|
|
634 | aio_block { |
459 | my ($src, $dst, $cb) = @_; |
635 | my ($src, $dst, $cb) = @_; |
460 | |
636 | |
461 | my $pri = aioreq_pri; |
637 | my $pri = aioreq_pri; |
462 | my $grp = aio_group $cb; |
638 | my $grp = aio_group $cb; |
463 | |
639 | |
464 | aioreq_pri $pri; |
640 | aioreq_pri $pri; |
465 | add $grp aio_open $src, O_RDONLY, 0, sub { |
641 | add $grp aio_open $src, O_RDONLY, 0, sub { |
466 | if (my $src_fh = $_[0]) { |
642 | if (my $src_fh = $_[0]) { |
467 | my @stat = stat $src_fh; |
643 | my @stat = stat $src_fh; |
468 | |
644 | |
469 | aioreq_pri $pri; |
645 | aioreq_pri $pri; |
470 | add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { |
646 | add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { |
471 | if (my $dst_fh = $_[0]) { |
647 | if (my $dst_fh = $_[0]) { |
472 | aioreq_pri $pri; |
648 | aioreq_pri $pri; |
473 | add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { |
649 | add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { |
474 | if ($_[0] == $stat[7]) { |
650 | if ($_[0] == $stat[7]) { |
475 | $grp->result (0); |
651 | $grp->result (0); |
476 | close $src_fh; |
652 | close $src_fh; |
477 | |
653 | |
478 | # those should not normally block. should. should. |
654 | # those should not normally block. should. should. |
479 | utime $stat[8], $stat[9], $dst; |
655 | utime $stat[8], $stat[9], $dst; |
480 | chmod $stat[2] & 07777, $dst_fh; |
656 | chmod $stat[2] & 07777, $dst_fh; |
481 | chown $stat[4], $stat[5], $dst_fh; |
657 | chown $stat[4], $stat[5], $dst_fh; |
|
|
658 | |
|
|
659 | aioreq_pri $pri; |
482 | close $dst_fh; |
660 | add $grp aio_close $dst_fh; |
483 | } else { |
661 | } else { |
484 | $grp->result (-1); |
662 | $grp->result (-1); |
485 | close $src_fh; |
663 | close $src_fh; |
486 | close $dst_fh; |
664 | close $dst_fh; |
487 | |
665 | |
488 | aioreq $pri; |
666 | aioreq $pri; |
489 | add $grp aio_unlink $dst; |
667 | add $grp aio_unlink $dst; |
|
|
668 | } |
490 | } |
669 | }; |
|
|
670 | } else { |
|
|
671 | $grp->result (-1); |
491 | }; |
672 | } |
492 | } else { |
|
|
493 | $grp->result (-1); |
|
|
494 | } |
673 | }, |
|
|
674 | |
|
|
675 | } else { |
|
|
676 | $grp->result (-1); |
495 | }, |
677 | } |
496 | |
|
|
497 | } else { |
|
|
498 | $grp->result (-1); |
|
|
499 | } |
678 | }; |
|
|
679 | |
|
|
680 | $grp |
500 | }; |
681 | } |
501 | |
|
|
502 | $grp |
|
|
503 | } |
682 | } |
504 | |
683 | |
505 | =item aio_move $srcpath, $dstpath, $callback->($status) |
684 | =item aio_move $srcpath, $dstpath, $callback->($status) |
506 | |
685 | |
507 | Try to move the I<file> (directories not supported as either source or |
686 | Try to move the I<file> (directories not supported as either source or |
… | |
… | |
513 | that is successful, unlinking the C<$srcpath>. |
692 | that is successful, unlinking the C<$srcpath>. |
514 | |
693 | |
515 | =cut |
694 | =cut |
516 | |
695 | |
517 | sub aio_move($$;$) { |
696 | sub aio_move($$;$) { |
|
|
697 | aio_block { |
518 | my ($src, $dst, $cb) = @_; |
698 | my ($src, $dst, $cb) = @_; |
519 | |
699 | |
520 | my $pri = aioreq_pri; |
700 | my $pri = aioreq_pri; |
521 | my $grp = aio_group $cb; |
701 | my $grp = aio_group $cb; |
522 | |
702 | |
523 | aioreq_pri $pri; |
703 | aioreq_pri $pri; |
524 | add $grp aio_rename $src, $dst, sub { |
704 | add $grp aio_rename $src, $dst, sub { |
525 | if ($_[0] && $! == EXDEV) { |
705 | if ($_[0] && $! == EXDEV) { |
526 | aioreq_pri $pri; |
706 | aioreq_pri $pri; |
527 | add $grp aio_copy $src, $dst, sub { |
707 | add $grp aio_copy $src, $dst, sub { |
|
|
708 | $grp->result ($_[0]); |
|
|
709 | |
|
|
710 | if (!$_[0]) { |
|
|
711 | aioreq_pri $pri; |
|
|
712 | add $grp aio_unlink $src; |
|
|
713 | } |
|
|
714 | }; |
|
|
715 | } else { |
528 | $grp->result ($_[0]); |
716 | $grp->result ($_[0]); |
529 | |
|
|
530 | if (!$_[0]) { |
|
|
531 | aioreq_pri $pri; |
|
|
532 | add $grp aio_unlink $src; |
|
|
533 | } |
|
|
534 | }; |
717 | } |
535 | } else { |
|
|
536 | $grp->result ($_[0]); |
|
|
537 | } |
718 | }; |
|
|
719 | |
|
|
720 | $grp |
538 | }; |
721 | } |
539 | |
|
|
540 | $grp |
|
|
541 | } |
722 | } |
542 | |
723 | |
543 | =item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
724 | =item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
544 | |
725 | |
545 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
726 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
… | |
… | |
592 | as those tend to return 0 or 1 as link counts, which disables the |
773 | as those tend to return 0 or 1 as link counts, which disables the |
593 | directory counting heuristic. |
774 | directory counting heuristic. |
594 | |
775 | |
595 | =cut |
776 | =cut |
596 | |
777 | |
597 | sub aio_scandir($$$) { |
778 | sub aio_scandir($$;$) { |
|
|
779 | aio_block { |
598 | my ($path, $maxreq, $cb) = @_; |
780 | my ($path, $maxreq, $cb) = @_; |
599 | |
781 | |
600 | my $pri = aioreq_pri; |
782 | my $pri = aioreq_pri; |
601 | |
783 | |
602 | my $grp = aio_group $cb; |
784 | my $grp = aio_group $cb; |
603 | |
785 | |
604 | $maxreq = 4 if $maxreq <= 0; |
786 | $maxreq = 4 if $maxreq <= 0; |
605 | |
787 | |
606 | # stat once |
788 | # stat once |
607 | aioreq_pri $pri; |
|
|
608 | add $grp aio_stat $path, sub { |
|
|
609 | return $grp->result () if $_[0]; |
|
|
610 | my $now = time; |
|
|
611 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
|
|
612 | |
|
|
613 | # read the directory entries |
|
|
614 | aioreq_pri $pri; |
789 | aioreq_pri $pri; |
615 | add $grp aio_readdir $path, sub { |
790 | add $grp aio_stat $path, sub { |
616 | my $entries = shift |
|
|
617 | or return $grp->result (); |
791 | return $grp->result () if $_[0]; |
|
|
792 | my $now = time; |
|
|
793 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
618 | |
794 | |
619 | # stat the dir another time |
795 | # read the directory entries |
620 | aioreq_pri $pri; |
796 | aioreq_pri $pri; |
|
|
797 | add $grp aio_readdir $path, sub { |
|
|
798 | my $entries = shift |
|
|
799 | or return $grp->result (); |
|
|
800 | |
|
|
801 | # stat the dir another time |
|
|
802 | aioreq_pri $pri; |
621 | add $grp aio_stat $path, sub { |
803 | add $grp aio_stat $path, sub { |
622 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
804 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
623 | |
805 | |
624 | my $ndirs; |
806 | my $ndirs; |
625 | |
807 | |
626 | # take the slow route if anything looks fishy |
808 | # take the slow route if anything looks fishy |
627 | if ($hash1 ne $hash2 or (stat _)[9] == $now) { |
809 | if ($hash1 ne $hash2 or (stat _)[9] == $now) { |
628 | $ndirs = -1; |
810 | $ndirs = -1; |
629 | } else { |
811 | } else { |
630 | # if nlink == 2, we are finished |
812 | # if nlink == 2, we are finished |
631 | # on non-posix-fs's, we rely on nlink < 2 |
813 | # on non-posix-fs's, we rely on nlink < 2 |
632 | $ndirs = (stat _)[3] - 2 |
814 | $ndirs = (stat _)[3] - 2 |
633 | or return $grp->result ([], $entries); |
815 | or return $grp->result ([], $entries); |
634 | } |
816 | } |
635 | |
817 | |
636 | # sort into likely dirs and likely nondirs |
818 | # sort into likely dirs and likely nondirs |
637 | # dirs == files without ".", short entries first |
819 | # dirs == files without ".", short entries first |
638 | $entries = [map $_->[0], |
820 | $entries = [map $_->[0], |
639 | sort { $b->[1] cmp $a->[1] } |
821 | sort { $b->[1] cmp $a->[1] } |
640 | map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], |
822 | map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], |
641 | @$entries]; |
823 | @$entries]; |
642 | |
824 | |
643 | my (@dirs, @nondirs); |
825 | my (@dirs, @nondirs); |
644 | |
826 | |
645 | my $statgrp = add $grp aio_group sub { |
827 | my $statgrp = add $grp aio_group sub { |
646 | $grp->result (\@dirs, \@nondirs); |
828 | $grp->result (\@dirs, \@nondirs); |
647 | }; |
829 | }; |
648 | |
830 | |
649 | limit $statgrp $maxreq; |
831 | limit $statgrp $maxreq; |
650 | feed $statgrp sub { |
832 | feed $statgrp sub { |
651 | return unless @$entries; |
833 | return unless @$entries; |
652 | my $entry = pop @$entries; |
834 | my $entry = pop @$entries; |
653 | |
835 | |
654 | aioreq_pri $pri; |
836 | aioreq_pri $pri; |
655 | add $statgrp aio_stat "$path/$entry/.", sub { |
837 | add $statgrp aio_stat "$path/$entry/.", sub { |
656 | if ($_[0] < 0) { |
838 | if ($_[0] < 0) { |
657 | push @nondirs, $entry; |
839 | push @nondirs, $entry; |
658 | } else { |
840 | } else { |
659 | # need to check for real directory |
841 | # need to check for real directory |
660 | aioreq_pri $pri; |
842 | aioreq_pri $pri; |
661 | add $statgrp aio_lstat "$path/$entry", sub { |
843 | add $statgrp aio_lstat "$path/$entry", sub { |
662 | if (-d _) { |
844 | if (-d _) { |
663 | push @dirs, $entry; |
845 | push @dirs, $entry; |
664 | |
846 | |
665 | unless (--$ndirs) { |
847 | unless (--$ndirs) { |
666 | push @nondirs, @$entries; |
848 | push @nondirs, @$entries; |
667 | feed $statgrp; |
849 | feed $statgrp; |
|
|
850 | } |
|
|
851 | } else { |
|
|
852 | push @nondirs, $entry; |
668 | } |
853 | } |
669 | } else { |
|
|
670 | push @nondirs, $entry; |
|
|
671 | } |
854 | } |
672 | } |
855 | } |
673 | } |
856 | }; |
674 | }; |
857 | }; |
675 | }; |
858 | }; |
676 | }; |
859 | }; |
677 | }; |
860 | }; |
|
|
861 | |
|
|
862 | $grp |
678 | }; |
863 | } |
679 | |
|
|
680 | $grp |
|
|
681 | } |
864 | } |
|
|
865 | |
|
|
866 | =item aio_rmtree $path, $callback->($status) |
|
|
867 | |
|
|
868 | Delete a directory tree starting (and including) C<$path>, return the |
|
|
869 | status of the final C<rmdir> only. This is a composite request that |
|
|
870 | uses C<aio_scandir> to recurse into and rmdir directories, and unlink |
|
|
871 | everything else. |
|
|
872 | |
|
|
873 | =cut |
|
|
874 | |
|
|
875 | sub aio_rmtree; |
|
|
876 | sub aio_rmtree($;$) { |
|
|
877 | aio_block { |
|
|
878 | my ($path, $cb) = @_; |
|
|
879 | |
|
|
880 | my $pri = aioreq_pri; |
|
|
881 | my $grp = aio_group $cb; |
|
|
882 | |
|
|
883 | aioreq_pri $pri; |
|
|
884 | add $grp aio_scandir $path, 0, sub { |
|
|
885 | my ($dirs, $nondirs) = @_; |
|
|
886 | |
|
|
887 | my $dirgrp = aio_group sub { |
|
|
888 | add $grp aio_rmdir $path, sub { |
|
|
889 | $grp->result ($_[0]); |
|
|
890 | }; |
|
|
891 | }; |
|
|
892 | |
|
|
893 | (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs; |
|
|
894 | (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs; |
|
|
895 | |
|
|
896 | add $grp $dirgrp; |
|
|
897 | }; |
|
|
898 | |
|
|
899 | $grp |
|
|
900 | } |
|
|
901 | } |
|
|
902 | |
|
|
903 | =item aio_sync $callback->($status) |
|
|
904 | |
|
|
905 | Asynchronously call sync and call the callback when finished. |
682 | |
906 | |
683 | =item aio_fsync $fh, $callback->($status) |
907 | =item aio_fsync $fh, $callback->($status) |
684 | |
908 | |
685 | Asynchronously call fsync on the given filehandle and call the callback |
909 | Asynchronously call fsync on the given filehandle and call the callback |
686 | with the fsync result code. |
910 | with the fsync result code. |
… | |
… | |
690 | Asynchronously call fdatasync on the given filehandle and call the |
914 | Asynchronously call fdatasync on the given filehandle and call the |
691 | callback with the fdatasync result code. |
915 | callback with the fdatasync result code. |
692 | |
916 | |
693 | If this call isn't available because your OS lacks it or it couldn't be |
917 | If this call isn't available because your OS lacks it or it couldn't be |
694 | detected, it will be emulated by calling C<fsync> instead. |
918 | detected, it will be emulated by calling C<fsync> instead. |
|
|
919 | |
|
|
920 | =item aio_pathsync $path, $callback->($status) |
|
|
921 | |
|
|
922 | This request tries to open, fsync and close the given path. This is a |
|
|
923 | composite request intended tosync directories after directory operations |
|
|
924 | (E.g. rename). This might not work on all operating systems or have any |
|
|
925 | specific effect, but usually it makes sure that directory changes get |
|
|
926 | written to disc. It works for anything that can be opened for read-only, |
|
|
927 | not just directories. |
|
|
928 | |
|
|
929 | Passes C<0> when everything went ok, and C<-1> on error. |
|
|
930 | |
|
|
931 | =cut |
|
|
932 | |
|
|
933 | sub aio_pathsync($;$) { |
|
|
934 | aio_block { |
|
|
935 | my ($path, $cb) = @_; |
|
|
936 | |
|
|
937 | my $pri = aioreq_pri; |
|
|
938 | my $grp = aio_group $cb; |
|
|
939 | |
|
|
940 | aioreq_pri $pri; |
|
|
941 | add $grp aio_open $path, O_RDONLY, 0, sub { |
|
|
942 | my ($fh) = @_; |
|
|
943 | if ($fh) { |
|
|
944 | aioreq_pri $pri; |
|
|
945 | add $grp aio_fsync $fh, sub { |
|
|
946 | $grp->result ($_[0]); |
|
|
947 | |
|
|
948 | aioreq_pri $pri; |
|
|
949 | add $grp aio_close $fh; |
|
|
950 | }; |
|
|
951 | } else { |
|
|
952 | $grp->result (-1); |
|
|
953 | } |
|
|
954 | }; |
|
|
955 | |
|
|
956 | $grp |
|
|
957 | } |
|
|
958 | } |
695 | |
959 | |
696 | =item aio_group $callback->(...) |
960 | =item aio_group $callback->(...) |
697 | |
961 | |
698 | This is a very special aio request: Instead of doing something, it is a |
962 | This is a very special aio request: Instead of doing something, it is a |
699 | container for other aio requests, which is useful if you want to bundle |
963 | container for other aio requests, which is useful if you want to bundle |
… | |
… | |
836 | itself. Useful when you queued a lot of events but got a result early. |
1100 | itself. Useful when you queued a lot of events but got a result early. |
837 | |
1101 | |
838 | =item $grp->result (...) |
1102 | =item $grp->result (...) |
839 | |
1103 | |
840 | Set the result value(s) that will be passed to the group callback when all |
1104 | Set the result value(s) that will be passed to the group callback when all |
841 | subrequests have finished and set thre groups errno to the current value |
1105 | subrequests have finished and set the groups errno to the current value |
842 | of errno (just like calling C<errno> without an error number). By default, |
1106 | of errno (just like calling C<errno> without an error number). By default, |
843 | no argument will be passed and errno is zero. |
1107 | no argument will be passed and errno is zero. |
844 | |
1108 | |
845 | =item $grp->errno ([$errno]) |
1109 | =item $grp->errno ([$errno]) |
846 | |
1110 | |
… | |
… | |
939 | that are being processed by C<IO::AIO::poll_cb> in one call, respectively |
1203 | that are being processed by C<IO::AIO::poll_cb> in one call, respectively |
940 | the maximum amount of time (default C<0>, meaning infinity) spent in |
1204 | the maximum amount of time (default C<0>, meaning infinity) spent in |
941 | C<IO::AIO::poll_cb> to process requests (more correctly the mininum amount |
1205 | C<IO::AIO::poll_cb> to process requests (more correctly the mininum amount |
942 | of time C<poll_cb> is allowed to use). |
1206 | of time C<poll_cb> is allowed to use). |
943 | |
1207 | |
|
|
1208 | Setting C<max_poll_time> to a non-zero value creates an overhead of one |
|
|
1209 | syscall per request processed, which is not normally a problem unless your |
|
|
1210 | callbacks are really really fast or your OS is really really slow (I am |
|
|
1211 | not mentioning Solaris here). Using C<max_poll_reqs> incurs no overhead. |
|
|
1212 | |
944 | Setting these is useful if you want to ensure some level of |
1213 | Setting these is useful if you want to ensure some level of |
945 | interactiveness when perl is not fast enough to process all requests in |
1214 | interactiveness when perl is not fast enough to process all requests in |
946 | time. |
1215 | time. |
947 | |
1216 | |
948 | For interactive programs, values such as C<0.01> to C<0.1> should be fine. |
1217 | For interactive programs, values such as C<0.01> to C<0.1> should be fine. |
949 | |
1218 | |
950 | Example: Install an Event watcher that automatically calls |
1219 | Example: Install an Event watcher that automatically calls |
951 | IO::AIO::poll_some with low priority, to ensure that other parts of the |
1220 | IO::AIO::poll_cb with low priority, to ensure that other parts of the |
952 | program get the CPU sometimes even under high AIO load. |
1221 | program get the CPU sometimes even under high AIO load. |
953 | |
1222 | |
954 | # try not to spend much more than 0.1s in poll_cb |
1223 | # try not to spend much more than 0.1s in poll_cb |
955 | IO::AIO::max_poll_time 0.1; |
1224 | IO::AIO::max_poll_time 0.1; |
956 | |
1225 | |
… | |
… | |
959 | poll => 'r', nice => 1, |
1228 | poll => 'r', nice => 1, |
960 | cb => &IO::AIO::poll_cb); |
1229 | cb => &IO::AIO::poll_cb); |
961 | |
1230 | |
962 | =item IO::AIO::poll_wait |
1231 | =item IO::AIO::poll_wait |
963 | |
1232 | |
|
|
1233 | If there are any outstanding requests and none of them in the result |
964 | Wait till the result filehandle becomes ready for reading (simply does a |
1234 | phase, wait till the result filehandle becomes ready for reading (simply |
965 | C<select> on the filehandle. This is useful if you want to synchronously |
1235 | does a C<select> on the filehandle. This is useful if you want to |
966 | wait for some requests to finish). |
1236 | synchronously wait for some requests to finish). |
967 | |
1237 | |
968 | See C<nreqs> for an example. |
1238 | See C<nreqs> for an example. |
969 | |
1239 | |
970 | =item IO::AIO::poll |
1240 | =item IO::AIO::poll |
971 | |
1241 | |
972 | Waits until some requests have been handled. |
1242 | Waits until some requests have been handled. |
973 | |
1243 | |
|
|
1244 | Returns the number of requests processed, but is otherwise strictly |
974 | Strictly equivalent to: |
1245 | equivalent to: |
975 | |
1246 | |
976 | IO::AIO::poll_wait, IO::AIO::poll_cb |
1247 | IO::AIO::poll_wait, IO::AIO::poll_cb |
977 | if IO::AIO::nreqs; |
|
|
978 | |
1248 | |
979 | =item IO::AIO::flush |
1249 | =item IO::AIO::flush |
980 | |
1250 | |
981 | Wait till all outstanding AIO requests have been handled. |
1251 | Wait till all outstanding AIO requests have been handled. |
982 | |
1252 | |
983 | Strictly equivalent to: |
1253 | Strictly equivalent to: |
984 | |
1254 | |
985 | IO::AIO::poll_wait, IO::AIO::poll_cb |
1255 | IO::AIO::poll_wait, IO::AIO::poll_cb |
986 | while IO::AIO::nreqs; |
1256 | while IO::AIO::nreqs; |
987 | |
1257 | |
|
|
1258 | =back |
|
|
1259 | |
988 | =head3 CONTROLLING THE NUMBER OF THREADS |
1260 | =head3 CONTROLLING THE NUMBER OF THREADS |
|
|
1261 | |
|
|
1262 | =over |
989 | |
1263 | |
990 | =item IO::AIO::min_parallel $nthreads |
1264 | =item IO::AIO::min_parallel $nthreads |
991 | |
1265 | |
992 | Set the minimum number of AIO threads to C<$nthreads>. The current |
1266 | Set the minimum number of AIO threads to C<$nthreads>. The current |
993 | default is C<8>, which means eight asynchronous operations can execute |
1267 | default is C<8>, which means eight asynchronous operations can execute |
… | |
… | |
1041 | This is a very bad function to use in interactive programs because it |
1315 | This is a very bad function to use in interactive programs because it |
1042 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1316 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1043 | use an C<aio_group> together with a feed callback. |
1317 | use an C<aio_group> together with a feed callback. |
1044 | |
1318 | |
1045 | Sets the maximum number of outstanding requests to C<$nreqs>. If you |
1319 | Sets the maximum number of outstanding requests to C<$nreqs>. If you |
1046 | to queue up more than this number of requests, the next call to the |
1320 | do queue up more than this number of requests, the next call to the |
1047 | C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>) |
1321 | C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>) |
1048 | function will block until the limit is no longer exceeded. |
1322 | function will block until the limit is no longer exceeded. |
1049 | |
1323 | |
1050 | The default value is very large, so there is no practical limit on the |
1324 | The default value is very large, so there is no practical limit on the |
1051 | number of outstanding requests. |
1325 | number of outstanding requests. |
1052 | |
1326 | |
1053 | You can still queue as many requests as you want. Therefore, |
1327 | You can still queue as many requests as you want. Therefore, |
1054 | C<max_oustsanding> is mainly useful in simple scripts (with low values) or |
1328 | C<max_oustsanding> is mainly useful in simple scripts (with low values) or |
1055 | as a stop gap to shield against fatal memory overflow (with large values). |
1329 | as a stop gap to shield against fatal memory overflow (with large values). |
1056 | |
1330 | |
|
|
1331 | =back |
|
|
1332 | |
1057 | =head3 STATISTICAL INFORMATION |
1333 | =head3 STATISTICAL INFORMATION |
|
|
1334 | |
|
|
1335 | =over |
1058 | |
1336 | |
1059 | =item IO::AIO::nreqs |
1337 | =item IO::AIO::nreqs |
1060 | |
1338 | |
1061 | Returns the number of requests currently in the ready, execute or pending |
1339 | Returns the number of requests currently in the ready, execute or pending |
1062 | states (i.e. for which their callback has not been invoked yet). |
1340 | states (i.e. for which their callback has not been invoked yet). |
… | |
… | |
1078 | |
1356 | |
1079 | =back |
1357 | =back |
1080 | |
1358 | |
1081 | =cut |
1359 | =cut |
1082 | |
1360 | |
1083 | # support function to convert a fd into a perl filehandle |
|
|
1084 | sub _fd2fh { |
|
|
1085 | return undef if $_[0] < 0; |
|
|
1086 | |
|
|
1087 | # try to generate nice filehandles |
|
|
1088 | my $sym = "IO::AIO::fd#$_[0]"; |
|
|
1089 | local *$sym; |
|
|
1090 | |
|
|
1091 | open *$sym, "+<&=$_[0]" # usually works under any unix |
|
|
1092 | or open *$sym, "<&=$_[0]" # cygwin needs this |
|
|
1093 | or open *$sym, ">&=$_[0]" # or this |
|
|
1094 | or return undef; |
|
|
1095 | |
|
|
1096 | *$sym |
|
|
1097 | } |
|
|
1098 | |
|
|
1099 | min_parallel 8; |
1361 | min_parallel 8; |
1100 | |
1362 | |
1101 | END { |
1363 | END { flush } |
1102 | min_parallel 1; |
|
|
1103 | flush; |
|
|
1104 | }; |
|
|
1105 | |
1364 | |
1106 | 1; |
1365 | 1; |
1107 | |
1366 | |
1108 | =head2 FORK BEHAVIOUR |
1367 | =head2 FORK BEHAVIOUR |
1109 | |
1368 | |
… | |
… | |
1129 | bytes of memory. In addition, stat requests need a stat buffer (possibly |
1388 | bytes of memory. In addition, stat requests need a stat buffer (possibly |
1130 | a few hundred bytes), readdir requires a result buffer and so on. Perl |
1389 | a few hundred bytes), readdir requires a result buffer and so on. Perl |
1131 | scalars and other data passed into aio requests will also be locked and |
1390 | scalars and other data passed into aio requests will also be locked and |
1132 | will consume memory till the request has entered the done state. |
1391 | will consume memory till the request has entered the done state. |
1133 | |
1392 | |
1134 | This is now awfully much, so queuing lots of requests is not usually a |
1393 | This is not awfully much, so queuing lots of requests is not usually a |
1135 | problem. |
1394 | problem. |
1136 | |
1395 | |
1137 | Per-thread usage: |
1396 | Per-thread usage: |
1138 | |
1397 | |
1139 | In the execution phase, some aio requests require more memory for |
1398 | In the execution phase, some aio requests require more memory for |