[ViewVC] Diff of: cvs/IO-AIO/AIO.pm

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.54 by root, Sun Oct 22 00:19:05 2006 UTC vs.
Revision 1.60 by root, Sun Oct 22 13:33:28 2006 UTC

  aio_read $fh, 30000, 1024, $buffer, 0, sub {
     $_[0] > 0 or die "read error: $!";
  };
- use IO::AIO 2; # version has aio objects
+ # version 2+ has request and group objects
+ use IO::AIO 2;
  my $req = aio_unlink "/tmp/file", sub { };
  $req->cancel; # cancel request if still in queue
- # AnyEvent
+ my $grp = aio_group sub { print "all stats done\n" };
+ add $grp aio_stat "..." for ...;
+ # AnyEvent integration
  open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!";
  my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb });
- # Event
+ # Event integration
  Event->io (fd => IO::AIO::poll_fileno,
             poll => 'r',
             cb => \&IO::AIO::poll_cb);
- # Glib/Gtk2
+ # Glib/Gtk2 integration
  add_watch Glib::IO IO::AIO::poll_fileno,
            in => sub { IO::AIO::poll_cb; 1 };
- # Tk
+ # Tk integration
  Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
                            readable => \&IO::AIO::poll_cb);
- # Danga::Socket
+ # Danga::Socket integration
  Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
                              \&IO::AIO::poll_cb);
 =head1 DESCRIPTION
 This module implements asynchronous I/O using whatever means your
 operating system supports.
 use strict 'vars';
 use base 'Exporter';
 BEGIN {
-   our $VERSION = '1.99';
+   our $VERSION = '2.0';
    our @EXPORT = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat
                     aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink
                     aio_fsync aio_fdatasync aio_readahead aio_rename aio_link aio_move
                     aio_group);
 syscall has been executed asynchronously.
 All functions expecting a filehandle keep a copy of the filehandle
 internally until the request has finished.
-All non-composite requests (requests that are not broken down into
-multiple requests) return objects of type L<IO::AIO::REQ> that allow
+All requests return objects of type L<IO::AIO::REQ> that allow further
-further manipulation of running requests.
+manipulation of those requests while they are in-flight.
 The pathnames you pass to these routines I<must> be absolute and
 encoded in byte form. The reason for the former is that at the time the
 request is being executed, the current working directory could have
 changed. Alternatively, you can make sure that you never change the
       print "read $_[0] bytes: <$buffer>\n";
    };
 =item aio_move $srcpath, $dstpath, $callback->($status)
+[EXPERIMENTAL due to internal aio_group use]
 Try to move the I<file> (directories not supported as either source or
 destination) from C<$srcpath> to C<$dstpath> and call the callback with
 the C<0> (error) or C<-1> ok.
 This is a composite request that tries to rename(2) the file first. If
 =cut
 sub aio_move($$$) {
    my ($src, $dst, $cb) = @_;
+   my $grp = aio_group $cb;
-   aio_rename $src, $dst, sub {
+   add $grp aio_rename $src, $dst, sub {
       if ($_[0] && $! == EXDEV) {
-         aio_open $src, O_RDONLY, 0, sub {
+         add $grp aio_open $src, O_RDONLY, 0, sub {
             if (my $src_fh = $_[0]) {
                my @stat = stat $src_fh;
-               aio_open $dst, O_WRONLY, 0200, sub {
+               add $grp aio_open $dst, O_WRONLY, 0200, sub {
                   if (my $dst_fh = $_[0]) {
-                     aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
+                     add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
                         close $src_fh;
                         if ($_[0] == $stat[7]) {
                            utime $stat[8], $stat[9], $dst;
                            chmod $stat[2] & 07777, $dst_fh;
                            chown $stat[4], $stat[5], $dst_fh;
                            close $dst_fh;
-                           aio_unlink $src, sub {
+                           add $grp aio_unlink $src, sub {
-                              $cb->($_[0]);
+                              $grp->result ($_[0]);
                            };
                         } else {
                            my $errno = $!;
-                           aio_unlink $dst, sub {
+                           add $grp aio_unlink $dst, sub {
                               $! = $errno;
-                              $cb->(-1);
+                              $grp->result (-1);
                            };
                         }
                      };
                   } else {
-                     $cb->(-1);
+                     $grp->result (-1);
                   }
                },
             } else {
-               $cb->(-1);
+               $grp->result (-1);
             }
          };
       } else {
-         $cb->($_[0]);
+         $grp->result ($_[0]);
       }
    };
+   $grp
 }
 =item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
 Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts
 The callback a single argument which is either C<undef> or an array-ref
 with the filenames.
 =item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
+[EXPERIMENTAL due to internal aio_group use]
 Scans a directory (similar to C<aio_readdir>) but additionally tries to
 separate the entries of directory C<$path> into two sets of names, ones
 you can recurse into (directories or links to them), and ones you cannot
 recurse into (everything else).
 =cut
 sub aio_scandir($$$) {
    my ($path, $maxreq, $cb) = @_;
+   my $grp = aio_group $cb;
    $maxreq = 8 if $maxreq <= 0;
    # stat once
-   aio_stat $path, sub {
+   add $grp aio_stat $path, sub {
-      return $cb->() if $_[0];
+      return $grp->result () if $_[0];
       my $now = time;
       my $hash1 = join ":", (stat _)[0,1,3,7,9];
       # read the directory entries
-      aio_readdir $path, sub {
+      add $grp aio_readdir $path, sub {
          my $entries = shift
-            or return $cb->();
+            or return $grp->result ();
          # stat the dir another time
-         aio_stat $path, sub {
+         add $grp aio_stat $path, sub {
             my $hash2 = join ":", (stat _)[0,1,3,7,9];
             my $ndirs;
             # take the slow route if anything looks fishy
                $ndirs = -1;
             } else {
                # if nlink == 2, we are finished
                # on non-posix-fs's, we rely on nlink < 2
                $ndirs = (stat _)[3] - 2
-                  or return $cb->([], $entries);
+                  or return $grp->result ([], $entries);
             }
             # sort into likely dirs and likely nondirs
             # dirs == files without ".", short entries first
             $entries = [map $_->[0],
             my (@dirs, @nondirs);
             my ($statcb, $schedcb);
             my $nreq = 0;
+            my $statgrp = add $grp aio_group;
             $schedcb = sub {
                if (@$entries) {
                   if ($nreq < $maxreq) {
                      my $ent = pop @$entries;
                      $nreq++;
-                     aio_stat "$path/$ent/.", sub { $statcb->($_[0], $ent) };
+                     add $statgrp aio_stat "$path/$ent/.", sub { $statcb->($_[0], $ent) };
                   }
                } elsif (!$nreq) {
                   # finished
+                  $statgrp->cancel;
                   undef $statcb;
                   undef $schedcb;
-                  $cb->(\@dirs, \@nondirs) if $cb;
+                  $grp->result (\@dirs, \@nondirs);
-                  undef $cb;
                }
             };
             $statcb = sub {
                my ($status, $entry) = @_;
                   $nreq--;
                   push @nondirs, $entry;
                   &$schedcb;
                } else {
                   # need to check for real directory
-                  aio_lstat "$path/$entry", sub {
+                  add $grp aio_lstat "$path/$entry", sub {
                      $nreq--;
                      if (-d _) {
                         push @dirs, $entry;
             &$schedcb while @$entries && $nreq < $maxreq;
          };
       };
    };
+   $grp
 }
 =item aio_fsync $fh, $callback->($status)
 Asynchronously call fsync on the given filehandle and call the callback
 callback with the fdatasync result code.
 If this call isn't available because your OS lacks it or it couldn't be
 detected, it will be emulated by calling C<fsync> instead.
-=item aio_group $callback->()
+=item aio_group $callback->(...)
+[EXPERIMENTAL]
+This is a very special aio request: Instead of doing something, it is a
+container for other aio requests, which is useful if you want to bundle
+many requests into a single, composite, request.
+Returns an object of class L<IO::AIO::GRP>. See its documentation below
+for more info.
+Example:
+   my $grp = aio_group sub {
+      print "all stats done\n";
+   };
+   add $grp
+      (aio_stat ...),
+      (aio_stat ...),
+      ...;
-=item aio_sleep $fractional_seconds, $callback->()  *NOT EXPORTED*
+=item IO::AIO::aio_sleep $fractional_seconds, $callback->()  *NOT EXPORTED*
 Mainly used for debugging and benchmarking, this aio request puts one of
 the request workers to sleep for the given time.
+While it is theoretically handy to have simple I/O scheduling requests
+like sleep and file handle readable/writable, the overhead this creates
+is immense, so do not use this function except to put your application
+under artificial I/O pressure.
 =back
 =head2 IO::AIO::REQ CLASS
 untouched. That means that requests that currently execute will not be
 stopped and resources held by the request will not be freed prematurely.
 =back
+=head2 IO::AIO::GRP CLASS
+This class is a subclass of L<IO::AIO::REQ>, so all its methods apply to
+objects of this class, too.
+A IO::AIO::GRP object is a special request that can contain multiple other
+aio requests.
+You create one by calling the C<aio_group> constructing function with a
+callback that will be called when all contained requests have entered the
+C<done> state:
+   my $grp = aio_group sub {
+      print "all requests are done\n";
+   };
+You add requests by calling the C<add> method with one or more
+C<IO::AIO::REQ> objects:
+   $grp->add (aio_unlink "...");
+   add $grp aio_stat "...", sub {
+      $_[0] or return $grp->result ("error");
+      # add another request dynamically, if first succeeded
+      add $grp aio_open "...", sub {
+         $grp->result ("ok");
+      };
+   };
+This makes it very easy to create composite requests (see the source of
+C<aio_move> for an application) that work and feel like simple requests.
+The IO::AIO::GRP objects will be cleaned up during calls to
+C<IO::AIO::poll_cb>, just like any other request.
+They can be canceled like any other request. Canceling will cancel not
+only the request itself, but also all requests it contains.
+They can also can also be added to other IO::AIO::GRP objects.
+You must not add requests to a group from within the group callback (or
+any later time).
+Their lifetime, simplified, looks like this: when they are empty, they
+will finish very quickly. If they contain only requests that are in the
+C<done> state, they will also finish. Otherwise they will continue to
+exist.
+That means after creating a group you have some time to add requests. And
+in the callbacks of those requests, you can add further requests to the
+group. And only when all those requests have finished will the the group
+itself finish.
+=over 4
+=item $grp->add (...)
+=item add $grp ...
+Add one or more requests to the group. Any type of L<IO::AIO::REQ> can
+be added, including other groups, as long as you do not create circular
+dependencies.
+Returns all its arguments.
+=item $grp->result (...)
+Set the result value(s) that will be passed to the group callback when all
+subrequests have finished. By default, no argument will be passed.
+=item $grp->set_feeder ($callback->($grp))
+[VERY EXPERIMENTAL]
+Sets a feeder/generator on this group: every group can have an attached
+generator that generates requests if idle. The idea behind this is that,
+although you could just queue as many requests as you want in a group,
+this might starve other requests for a potentially long time.  For
+example, C<aio_scandir> might generate hundreds of thousands C<aio_stat>
+requests, delaying any later requests for a long time.
+To avoid this, and allow incremental generation of requests, you can
+instead a group and set a feeder on it that generates those requests. The
+feeder will be called whenever there are few enough (see C<feeder_limit>,
+below) requests active in the group itself and is expected to queue more
+requests.
+The feeder can queue as many requests as it likes (i.e. C<add> does not
+impose any limits).
+If the feeder does not queue more requests when called, it will be
+automatically removed from the group.
+If the feeder limit is C<0>, it will be set to C<2> automatically.
+Example:
+   # stat all files in @files, but only ever use four aio requests concurrently:
+   my $grp = aio_group sub { print "finished\n" };
+   $grp->feeder_limit (4);
+   $grp->set_feeder (sub {
+      my $file = pop @files
+         or return;
+      add $grp aio_stat $file, sub { ... };
+   });
+=item $grp->feeder_limit ($num)
+Sets the feeder limit for the group: The feeder will be called whenever
+the group contains less than this many requests.
+Setting the limit to C<0> will pause the feeding process.
+=back
 =head2 SUPPORT FUNCTIONS
 =over 4
 =item $fileno = IO::AIO::poll_fileno
 In short: the parent will, after a short pause, continue as if fork had
 not been called, while the child will act as if IO::AIO has not been used
 yet.
+=head2 MEMORY USAGE
+Each aio request uses - depending on your architecture - around 128 bytes
+of memory.  In addition, stat requests need a stat buffer (possibly a few
+hundred bytes). Perl scalars and other data passed into aio requests will
+also be locked.
+This is now awfully much, so queuing lots of requests is not usually a
+problem.
+Each thread needs a stack area which is usually around 16k, sometimes much
+larger, depending on the OS.
 =head1 SEE ALSO
 L<Coro>, L<Linux::AIO> (obsolete).
 =head1 AUTHOR

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing IO-AIO/AIO.pm (file contents): Revision 1.54 by root, Sun Oct 22 00:19:05 2006 UTC vs. Revision 1.60 by root, Sun Oct 22 13:33:28 2006 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.54 by root, Sun Oct 22 00:19:05 2006 UTC vs.
Revision 1.60 by root, Sun Oct 22 13:33:28 2006 UTC