| … | |
… | |
| 15 | |
15 | |
| 16 | aio_read $fh, 30000, 1024, $buffer, 0, sub { |
16 | aio_read $fh, 30000, 1024, $buffer, 0, sub { |
| 17 | $_[0] > 0 or die "read error: $!"; |
17 | $_[0] > 0 or die "read error: $!"; |
| 18 | }; |
18 | }; |
| 19 | |
19 | |
| 20 | use IO::AIO 2; # version has aio objects |
20 | # version 2+ has request and group objects |
|
|
21 | use IO::AIO 2; |
| 21 | |
22 | |
| 22 | my $req = aio_unlink "/tmp/file", sub { }; |
23 | my $req = aio_unlink "/tmp/file", sub { }; |
| 23 | $req->cancel; # cancel request if still in queue |
24 | $req->cancel; # cancel request if still in queue |
| 24 | |
25 | |
| 25 | # AnyEvent |
26 | my $grp = aio_group sub { print "all stats done\n" }; |
|
|
27 | add $grp aio_stat "..." for ...; |
|
|
28 | |
|
|
29 | # AnyEvent integration |
| 26 | open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!"; |
30 | open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!"; |
| 27 | my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb }); |
31 | my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb }); |
| 28 | |
32 | |
| 29 | # Event |
33 | # Event integration |
| 30 | Event->io (fd => IO::AIO::poll_fileno, |
34 | Event->io (fd => IO::AIO::poll_fileno, |
| 31 | poll => 'r', |
35 | poll => 'r', |
| 32 | cb => \&IO::AIO::poll_cb); |
36 | cb => \&IO::AIO::poll_cb); |
| 33 | |
37 | |
| 34 | # Glib/Gtk2 |
38 | # Glib/Gtk2 integration |
| 35 | add_watch Glib::IO IO::AIO::poll_fileno, |
39 | add_watch Glib::IO IO::AIO::poll_fileno, |
| 36 | in => sub { IO::AIO::poll_cb; 1 }; |
40 | in => sub { IO::AIO::poll_cb; 1 }; |
| 37 | |
41 | |
| 38 | # Tk |
42 | # Tk integration |
| 39 | Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "", |
43 | Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "", |
| 40 | readable => \&IO::AIO::poll_cb); |
44 | readable => \&IO::AIO::poll_cb); |
| 41 | |
45 | |
| 42 | # Danga::Socket |
46 | # Danga::Socket integration |
| 43 | Danga::Socket->AddOtherFds (IO::AIO::poll_fileno => |
47 | Danga::Socket->AddOtherFds (IO::AIO::poll_fileno => |
| 44 | \&IO::AIO::poll_cb); |
48 | \&IO::AIO::poll_cb); |
| 45 | |
|
|
| 46 | |
49 | |
| 47 | =head1 DESCRIPTION |
50 | =head1 DESCRIPTION |
| 48 | |
51 | |
| 49 | This module implements asynchronous I/O using whatever means your |
52 | This module implements asynchronous I/O using whatever means your |
| 50 | operating system supports. |
53 | operating system supports. |
| … | |
… | |
| 179 | print "read $_[0] bytes: <$buffer>\n"; |
182 | print "read $_[0] bytes: <$buffer>\n"; |
| 180 | }; |
183 | }; |
| 181 | |
184 | |
| 182 | =item aio_move $srcpath, $dstpath, $callback->($status) |
185 | =item aio_move $srcpath, $dstpath, $callback->($status) |
| 183 | |
186 | |
|
|
187 | [EXPERIMENTAL due to internal aio_group use] |
|
|
188 | |
| 184 | Try to move the I<file> (directories not supported as either source or |
189 | Try to move the I<file> (directories not supported as either source or |
| 185 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
190 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
| 186 | the C<0> (error) or C<-1> ok. |
191 | the C<0> (error) or C<-1> ok. |
| 187 | |
192 | |
| 188 | This is a composite request that tries to rename(2) the file first. If |
193 | This is a composite request that tries to rename(2) the file first. If |
| … | |
… | |
| 198 | =cut |
203 | =cut |
| 199 | |
204 | |
| 200 | sub aio_move($$$) { |
205 | sub aio_move($$$) { |
| 201 | my ($src, $dst, $cb) = @_; |
206 | my ($src, $dst, $cb) = @_; |
| 202 | |
207 | |
| 203 | my $grp = aio_group; |
208 | my $grp = aio_group $cb; |
| 204 | |
209 | |
| 205 | add $grp aio_rename $src, $dst, sub { |
210 | add $grp aio_rename $src, $dst, sub { |
| 206 | if ($_[0] && $! == EXDEV) { |
211 | if ($_[0] && $! == EXDEV) { |
| 207 | add $grp aio_open $src, O_RDONLY, 0, sub { |
212 | add $grp aio_open $src, O_RDONLY, 0, sub { |
| 208 | if (my $src_fh = $_[0]) { |
213 | if (my $src_fh = $_[0]) { |
| … | |
… | |
| 218 | chmod $stat[2] & 07777, $dst_fh; |
223 | chmod $stat[2] & 07777, $dst_fh; |
| 219 | chown $stat[4], $stat[5], $dst_fh; |
224 | chown $stat[4], $stat[5], $dst_fh; |
| 220 | close $dst_fh; |
225 | close $dst_fh; |
| 221 | |
226 | |
| 222 | add $grp aio_unlink $src, sub { |
227 | add $grp aio_unlink $src, sub { |
| 223 | $cb->($_[0]); |
228 | $grp->result ($_[0]); |
| 224 | }; |
229 | }; |
| 225 | } else { |
230 | } else { |
| 226 | my $errno = $!; |
231 | my $errno = $!; |
| 227 | add $grp aio_unlink $dst, sub { |
232 | add $grp aio_unlink $dst, sub { |
| 228 | $! = $errno; |
233 | $! = $errno; |
| 229 | $cb->(-1); |
234 | $grp->result (-1); |
| 230 | }; |
235 | }; |
| 231 | } |
236 | } |
| 232 | }; |
237 | }; |
| 233 | } else { |
238 | } else { |
| 234 | $cb->(-1); |
239 | $grp->result (-1); |
| 235 | } |
240 | } |
| 236 | }, |
241 | }, |
| 237 | |
242 | |
| 238 | } else { |
243 | } else { |
| 239 | $cb->(-1); |
244 | $grp->result (-1); |
| 240 | } |
245 | } |
| 241 | }; |
246 | }; |
| 242 | } else { |
247 | } else { |
| 243 | $cb->($_[0]); |
248 | $grp->result ($_[0]); |
| 244 | } |
249 | } |
| 245 | }; |
250 | }; |
| 246 | |
251 | |
| 247 | $grp |
252 | $grp |
| 248 | } |
253 | } |
| … | |
… | |
| 340 | The callback a single argument which is either C<undef> or an array-ref |
345 | The callback a single argument which is either C<undef> or an array-ref |
| 341 | with the filenames. |
346 | with the filenames. |
| 342 | |
347 | |
| 343 | =item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
348 | =item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
| 344 | |
349 | |
|
|
350 | [EXPERIMENTAL due to internal aio_group use] |
|
|
351 | |
| 345 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
352 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
| 346 | separate the entries of directory C<$path> into two sets of names, ones |
353 | separate the entries of directory C<$path> into two sets of names, ones |
| 347 | you can recurse into (directories or links to them), and ones you cannot |
354 | you can recurse into (directories or links to them), and ones you cannot |
| 348 | recurse into (everything else). |
355 | recurse into (everything else). |
| 349 | |
356 | |
| … | |
… | |
| 395 | =cut |
402 | =cut |
| 396 | |
403 | |
| 397 | sub aio_scandir($$$) { |
404 | sub aio_scandir($$$) { |
| 398 | my ($path, $maxreq, $cb) = @_; |
405 | my ($path, $maxreq, $cb) = @_; |
| 399 | |
406 | |
| 400 | my $grp = aio_group; |
407 | my $grp = aio_group $cb; |
| 401 | |
408 | |
| 402 | $maxreq = 8 if $maxreq <= 0; |
409 | $maxreq = 8 if $maxreq <= 0; |
| 403 | |
410 | |
| 404 | # stat once |
411 | # stat once |
| 405 | add $grp aio_stat $path, sub { |
412 | add $grp aio_stat $path, sub { |
| 406 | return $cb->() if $_[0]; |
413 | return $grp->result () if $_[0]; |
| 407 | my $now = time; |
414 | my $now = time; |
| 408 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
415 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
| 409 | |
416 | |
| 410 | # read the directory entries |
417 | # read the directory entries |
| 411 | add $grp aio_readdir $path, sub { |
418 | add $grp aio_readdir $path, sub { |
| 412 | my $entries = shift |
419 | my $entries = shift |
| 413 | or return $cb->(); |
420 | or return $grp->result (); |
| 414 | |
421 | |
| 415 | # stat the dir another time |
422 | # stat the dir another time |
| 416 | add $grp aio_stat $path, sub { |
423 | add $grp aio_stat $path, sub { |
| 417 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
424 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
| 418 | |
425 | |
| … | |
… | |
| 423 | $ndirs = -1; |
430 | $ndirs = -1; |
| 424 | } else { |
431 | } else { |
| 425 | # if nlink == 2, we are finished |
432 | # if nlink == 2, we are finished |
| 426 | # on non-posix-fs's, we rely on nlink < 2 |
433 | # on non-posix-fs's, we rely on nlink < 2 |
| 427 | $ndirs = (stat _)[3] - 2 |
434 | $ndirs = (stat _)[3] - 2 |
| 428 | or return $cb->([], $entries); |
435 | or return $grp->result ([], $entries); |
| 429 | } |
436 | } |
| 430 | |
437 | |
| 431 | # sort into likely dirs and likely nondirs |
438 | # sort into likely dirs and likely nondirs |
| 432 | # dirs == files without ".", short entries first |
439 | # dirs == files without ".", short entries first |
| 433 | $entries = [map $_->[0], |
440 | $entries = [map $_->[0], |
| … | |
… | |
| 449 | } |
456 | } |
| 450 | } elsif (!$nreq) { |
457 | } elsif (!$nreq) { |
| 451 | # finished |
458 | # finished |
| 452 | undef $statcb; |
459 | undef $statcb; |
| 453 | undef $schedcb; |
460 | undef $schedcb; |
| 454 | $cb->(\@dirs, \@nondirs) if $cb; |
461 | $grp->result (\@dirs, \@nondirs) if $cb; |
| 455 | undef $cb; |
462 | undef $cb; |
| 456 | } |
463 | } |
| 457 | }; |
464 | }; |
| 458 | $statcb = sub { |
465 | $statcb = sub { |
| 459 | my ($status, $entry) = @_; |
466 | my ($status, $entry) = @_; |
| … | |
… | |
| 502 | callback with the fdatasync result code. |
509 | callback with the fdatasync result code. |
| 503 | |
510 | |
| 504 | If this call isn't available because your OS lacks it or it couldn't be |
511 | If this call isn't available because your OS lacks it or it couldn't be |
| 505 | detected, it will be emulated by calling C<fsync> instead. |
512 | detected, it will be emulated by calling C<fsync> instead. |
| 506 | |
513 | |
| 507 | =item aio_group $callback->() |
514 | =item aio_group $callback->(...) |
| 508 | |
515 | |
| 509 | [EXPERIMENTAL] |
516 | [EXPERIMENTAL] |
| 510 | |
517 | |
| 511 | This is a very special aio request: Instead of doing something, it is a |
518 | This is a very special aio request: Instead of doing something, it is a |
| 512 | container for other aio requests, which is useful if you want to bundle |
519 | container for other aio requests, which is useful if you want to bundle |
| … | |
… | |
| 524 | add $grp |
531 | add $grp |
| 525 | (aio_stat ...), |
532 | (aio_stat ...), |
| 526 | (aio_stat ...), |
533 | (aio_stat ...), |
| 527 | ...; |
534 | ...; |
| 528 | |
535 | |
| 529 | =item aio_sleep $fractional_seconds, $callback->() *NOT EXPORTED* |
536 | =item IO::AIO::aio_sleep $fractional_seconds, $callback->() *NOT EXPORTED* |
| 530 | |
537 | |
| 531 | Mainly used for debugging and benchmarking, this aio request puts one of |
538 | Mainly used for debugging and benchmarking, this aio request puts one of |
| 532 | the request workers to sleep for the given time. |
539 | the request workers to sleep for the given time. |
|
|
540 | |
|
|
541 | While it is theoretically handy to have simple I/O scheduling requests |
|
|
542 | like sleep and file handle readable/writable, the overhead this creates |
|
|
543 | is immense, so do not use this function except to put your application |
|
|
544 | under artificial I/O pressure. |
| 533 | |
545 | |
| 534 | =back |
546 | =back |
| 535 | |
547 | |
| 536 | =head2 IO::AIO::REQ CLASS |
548 | =head2 IO::AIO::REQ CLASS |
| 537 | |
549 | |
| … | |
… | |
| 577 | You add requests by calling the C<add> method with one or more |
589 | You add requests by calling the C<add> method with one or more |
| 578 | C<IO::AIO::REQ> objects: |
590 | C<IO::AIO::REQ> objects: |
| 579 | |
591 | |
| 580 | $grp->add (aio_unlink "..."); |
592 | $grp->add (aio_unlink "..."); |
| 581 | |
593 | |
| 582 | add $grp aio_stat "...", sub { ... }; |
594 | add $grp aio_stat "...", sub { |
|
|
595 | $_[0] or return $grp->result ("error"); |
|
|
596 | |
|
|
597 | # add another request dynamically, if first succeeded |
|
|
598 | add $grp aio_open "...", sub { |
|
|
599 | $grp->result ("ok"); |
|
|
600 | }; |
|
|
601 | }; |
| 583 | |
602 | |
| 584 | This makes it very easy to create composite requests (see the source of |
603 | This makes it very easy to create composite requests (see the source of |
| 585 | C<aio_move> for an application) that work and feel like simple requests. |
604 | C<aio_move> for an application) that work and feel like simple requests. |
| 586 | |
605 | |
| 587 | The IO::AIO::GRP objects will be cleaned up during calls to |
606 | The IO::AIO::GRP objects will be cleaned up during calls to |
| … | |
… | |
| 595 | Their lifetime, simplified, looks like this: when they are empty, they |
614 | Their lifetime, simplified, looks like this: when they are empty, they |
| 596 | will finish very quickly. If they contain only requests that are in the |
615 | will finish very quickly. If they contain only requests that are in the |
| 597 | C<done> state, they will also finish. Otherwise they will continue to |
616 | C<done> state, they will also finish. Otherwise they will continue to |
| 598 | exist. |
617 | exist. |
| 599 | |
618 | |
|
|
619 | That means after creating a group you have some time to add requests. And |
|
|
620 | in the callbacks of those requests, you can add further requests to the |
|
|
621 | group. And only when all those requests have finished will the the group |
|
|
622 | itself finish. |
|
|
623 | |
| 600 | =over 4 |
624 | =over 4 |
| 601 | |
625 | |
| 602 | =item $grp->add (...) |
626 | =item $grp->add (...) |
| 603 | |
627 | |
| 604 | =item add $grp ... |
628 | =item add $grp ... |
| 605 | |
629 | |
| 606 | Add one or more |
630 | Add one or more requests to the group. Any type of L<IO::AIO::REQ> can |
| 607 | Cancels the request, if possible. Has the effect of skipping execution |
631 | be added, including other groups, as long as you do not create circular |
| 608 | when entering the B<execute> state and skipping calling the callback when |
632 | dependencies. |
| 609 | entering the the B<result> state, but will leave the request otherwise |
633 | |
| 610 | untouched. That means that requests that currently execute will not be |
634 | Returns all its arguments. |
| 611 | stopped and resources held by the request will not be freed prematurely. |
635 | |
|
|
636 | =item $grp->result (...) |
|
|
637 | |
|
|
638 | Set the result value(s) that will be passed to the group callback when all |
|
|
639 | subrequests have finished. By default, no argument will be passed. |
| 612 | |
640 | |
| 613 | =back |
641 | =back |
| 614 | |
642 | |
| 615 | =head2 SUPPORT FUNCTIONS |
643 | =head2 SUPPORT FUNCTIONS |
| 616 | |
644 | |
