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

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.181 by root, Tue May 4 21:14:01 2010 UTC vs.
Revision 1.232 by root, Mon Jul 30 16:46:30 2012 UTC

 use common::sense;
 use base 'Exporter';
 BEGIN {
-   our $VERSION = '3.65';
+   our $VERSION = '4.15';
-   our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close
+   our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close
                      aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx
-                     aio_scandir aio_symlink aio_readlink aio_sync aio_fsync
+                     aio_scandir aio_symlink aio_readlink aio_realpath aio_sync
-                     aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead
+                     aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_fallocate
+                     aio_pathsync aio_readahead aio_fiemap
                      aio_rename aio_link aio_move aio_copy aio_group
                      aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
                      aio_chmod aio_utime aio_truncate
-                     aio_msync aio_mtouch aio_statvfs);
+                     aio_msync aio_mtouch aio_mlock aio_mlockall
+                     aio_statvfs
+                     aio_wd);
    our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
    our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
-                       min_parallel max_parallel max_idle
+                       min_parallel max_parallel max_idle idle_timeout
                        nreqs nready npending nthreads
                        max_poll_time max_poll_reqs
-                       sendfile fadvise);
+                       sendfile fadvise madvise
+                       mmap munmap munlock munlockall);
    push @AIO_REQ, qw(aio_busy); # not exported
    @IO::AIO::GRP::ISA = 'IO::AIO::REQ';
 =head1 FUNCTIONS
 =head2 QUICK OVERVIEW
-This section simply lists the prototypes of the most important functions
+This section simply lists the prototypes most of the functions for
-for quick reference. See the following sections for function-by-function
+quick reference. See the following sections for function-by-function
 documentation.
+   aio_wd $pathname, $callback->($wd)
    aio_open $pathname, $flags, $mode, $callback->($fh)
    aio_close $fh, $callback->($status)
+   aio_seek  $fh,$offset,$whence, $callback->($offs)
    aio_read  $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
    aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
    aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
    aio_readahead $fh,$offset,$length, $callback->($retval)
    aio_stat  $fh_or_path, $callback->($status)
    aio_lstat $fh, $callback->($status)
    aio_statvfs $fh_or_path, $callback->($statvfs)
    aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
    aio_chown $fh_or_path, $uid, $gid, $callback->($status)
+   aio_chmod $fh_or_path, $mode, $callback->($status)
    aio_truncate $fh_or_path, $offset, $callback->($status)
-   aio_chmod $fh_or_path, $mode, $callback->($status)
+   aio_allocate $fh, $mode, $offset, $len, $callback->($status)
+   aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
    aio_unlink $pathname, $callback->($status)
-   aio_mknod $path, $mode, $dev, $callback->($status)
+   aio_mknod $pathname, $mode, $dev, $callback->($status)
    aio_link $srcpath, $dstpath, $callback->($status)
    aio_symlink $srcpath, $dstpath, $callback->($status)
-   aio_readlink $path, $callback->($link)
+   aio_readlink $pathname, $callback->($link)
+   aio_realpath $pathname, $callback->($link)
    aio_rename $srcpath, $dstpath, $callback->($status)
    aio_mkdir $pathname, $mode, $callback->($status)
    aio_rmdir $pathname, $callback->($status)
    aio_readdir $pathname, $callback->($entries)
    aio_readdirx $pathname, $flags, $callback->($entries, $flags)
       IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST
       IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN
+   aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
-   aio_load $path, $data, $callback->($status)
+   aio_load $pathname, $data, $callback->($status)
    aio_copy $srcpath, $dstpath, $callback->($status)
    aio_move $srcpath, $dstpath, $callback->($status)
-   aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
-   aio_rmtree $path, $callback->($status)
+   aio_rmtree $pathname, $callback->($status)
    aio_sync $callback->($status)
+   aio_syncfs $fh, $callback->($status)
    aio_fsync $fh, $callback->($status)
    aio_fdatasync $fh, $callback->($status)
    aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
-   aio_pathsync $path, $callback->($status)
+   aio_pathsync $pathname, $callback->($status)
    aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
    aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
+   aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
+   aio_mlockall $flags, $callback->($status)
    aio_group $callback->(...)
    aio_nop $callback->()
    $prev_pri = aioreq_pri [$pri]
    aioreq_nice $pri_adjust
    IO::AIO::max_poll_reqs $nreqs
    IO::AIO::max_poll_time $seconds
    IO::AIO::min_parallel $nthreads
    IO::AIO::max_parallel $nthreads
    IO::AIO::max_idle $nthreads
+   IO::AIO::idle_timeout $seconds
    IO::AIO::max_outstanding $maxreqs
    IO::AIO::nreqs
    IO::AIO::nready
    IO::AIO::npending
    IO::AIO::sendfile $ofh, $ifh, $offset, $count
    IO::AIO::fadvise $fh, $offset, $len, $advice
-   IO::AIO::mlockall $flags
+   IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]
+   IO::AIO::munmap $scalar
+   IO::AIO::madvise $scalar, $offset, $length, $advice
+   IO::AIO::mprotect $scalar, $offset, $length, $protect
+   IO::AIO::munlock $scalar, $offset = 0, $length = undef
    IO::AIO::munlockall
-=head2 AIO REQUEST FUNCTIONS
+=head2 API NOTES
 All the C<aio_*> calls are more or less thin wrappers around the syscall
 with the same name (sans C<aio_>). The arguments are similar or identical,
 and they all accept an additional (and optional) C<$callback> argument
-which must be a code reference. This code reference will get called with
+which must be a code reference. This code reference will be called after
-the syscall return code (e.g. most syscalls return C<-1> on error, unlike
+the syscall has been executed in an asynchronous fashion. The results
-perl, which usually delivers "false") as its sole argument after the given
+of the request will be passed as arguments to the callback (and, if an
-syscall has been executed asynchronously.
+error occured, in C<$!>) - for most requests the syscall return code (e.g.
+most syscalls return C<-1> on error, unlike perl, which usually delivers
+"false").
+Some requests (such as C<aio_readdir>) pass the actual results and
+communicate failures by passing C<undef>.
 All functions expecting a filehandle keep a copy of the filehandle
 internally until the request has finished.
 All functions return request objects of type L<IO::AIO::REQ> that allow
 further manipulation of those requests while they are in-flight.
-The pathnames you pass to these routines I<must> be absolute and
+The pathnames you pass to these routines I<should> be absolute. The
-encoded as octets. The reason for the former is that at the time the
+reason for this is that at the time the request is being executed, the
-request is being executed, the current working directory could have
+current working directory could have changed. Alternatively, you can
-changed. Alternatively, you can make sure that you never change the
+make sure that you never change the current working directory anywhere
-current working directory anywhere in the program and then use relative
+in the program and then use relative paths. You can also take advantage
-paths.
+of IO::AIOs working directory abstraction, that lets you specify paths
+relative to some previously-opened "working directory object" - see the
+description of the C<IO::AIO::WD> class later in this document.
 To encode pathnames as octets, either make sure you either: a) always pass
 in filenames you got from outside (command line, readdir etc.) without
-tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module and encode
+tinkering, b) are in your native filesystem encoding, c) use the Encode
-your pathnames to the locale (or other) encoding in effect in the user
+module and encode your pathnames to the locale (or other) encoding in
-environment, d) use Glib::filename_from_unicode on unicode filenames or e)
+effect in the user environment, d) use Glib::filename_from_unicode on
-use something else to ensure your scalar has the correct contents.
+unicode filenames or e) use something else to ensure your scalar has the
+correct contents.
 This works, btw. independent of the internal UTF-8 bit, which IO::AIO
 handles correctly whether it is set or not.
+=head2 AIO REQUEST FUNCTIONS
 =over 4
 =item $prev_pri = aioreq_pri [$pri]
       } else {
          die "open failed: $!\n";
       }
    };
+In addition to all the common open modes/flags (C<O_RDONLY>, C<O_WRONLY>,
+C<O_RDWR>, C<O_CREAT>, C<O_TRUNC>, C<O_EXCL> and C<O_APPEND>), the
+following POSIX and non-POSIX constants are available (missing ones on
+your system are, as usual, C<0>):
+C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>,
+C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>,
+C<O_RSYNC>, C<O_SYNC> and C<O_TTY_INIT>.
 =item aio_close $fh, $callback->($status)
 Asynchronously close a file and call the callback with the result
 code.
 Or in other words: the file descriptor will be closed, but it will not be
 free for reuse until the perl filehandle is closed.
 =cut
+=item aio_seek $fh, $offset, $whence, $callback->($offs)
+Seeks the filehandle to the new C<$offset>, similarly to perl's
+C<sysseek>. The C<$whence> can use the traditional values (C<0> for
+C<IO::AIO::SEEK_SET>, C<1> for C<IO::AIO::SEEK_CUR> or C<2> for
+C<IO::AIO::SEEK_END>).
+The resulting absolute offset will be passed to the callback, or C<-1> in
+case of an error.
+In theory, the C<$whence> constants could be different than the
+corresponding values from L<Fcntl>, but perl guarantees they are the same,
+so don't panic.
+As a GNU/Linux (and maybe Solaris) extension, also the constants
+C<IO::AIO::SEEK_DATA> and C<IO::AIO::SEEK_HOLE> are available, if they
+could be found. No guarantees about suitability for use in C<aio_seek> or
+Perl's C<sysseek> can be made though, although I would naively assume they
+"just work".
 =item aio_read  $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
 =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
 Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts
 reading at byte offset C<$in_offset>, and starts writing at the current
 file offset of C<$out_fh>. Because of that, it is not safe to issue more
 than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each
-other.
+other. The same C<$in_fh> works fine though, as this function does not
+move or use the file offset of C<$in_fh>.
+Please note that C<aio_sendfile> can read more bytes from C<$in_fh> than
+are written, and there is no way to find out how many more bytes have been
+read from C<aio_sendfile> alone, as C<aio_sendfile> only provides the
+number of bytes written to C<$out_fh>. Only if the result value equals
+C<$length> one can assume that C<$length> bytes have been read.
+Unlike with other C<aio_> functions, it makes a lot of sense to use
+C<aio_sendfile> on non-blocking sockets, as long as one end (typically
+the C<$in_fh>) is a file - the file I/O will then be asynchronous, while
+the socket I/O will be non-blocking. Note, however, that you can run
+into a trap where C<aio_sendfile> reads some data with readahead, then
+fails to write all data, and when the socket is ready the next time, the
+data in the cache is already lost, forcing C<aio_sendfile> to again hit
+the disk. Explicit C<aio_read> + C<aio_write> let's you better control
+resource usage.
-This call tries to make use of a native C<sendfile> syscall to provide
+This call tries to make use of a native C<sendfile>-like syscall to
-zero-copy operation. For this to work, C<$out_fh> should refer to a
+provide zero-copy operation. For this to work, C<$out_fh> should refer to
-socket, and C<$in_fh> should refer to an mmap'able file.
+a socket, and C<$in_fh> should refer to an mmap'able file.
 If a native sendfile cannot be found or it fails with C<ENOSYS>,
-C<ENOTSUP>, C<EOPNOTSUPP>, C<EAFNOSUPPORT>, C<EPROTOTYPE> or C<ENOTSOCK>,
+C<EINVAL>, C<ENOTSUP>, C<EOPNOTSUPP>, C<EAFNOSUPPORT>, C<EPROTOTYPE> or
-it will be emulated, so you can call C<aio_sendfile> on any type of
+C<ENOTSOCK>, it will be emulated, so you can call C<aio_sendfile> on any
-filehandle regardless of the limitations of the operating system.
+type of filehandle regardless of the limitations of the operating system.
-Please note, however, that C<aio_sendfile> can read more bytes from
+As native sendfile syscalls (as practically any non-POSIX interface hacked
-C<$in_fh> than are written, and there is no way to find out how many
+together in a hurry to improve benchmark numbers) tend to be rather buggy
-bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only
+on many systems, this implementation tries to work around some known bugs
-provides the number of bytes written to C<$out_fh>. Only if the result
+in Linux and FreeBSD kernels (probably others, too), but that might fail,
-value equals C<$length> one can assume that C<$length> bytes have been
+so you really really should check the return value of C<aio_sendfile> -
-read.
+fewre bytes than expected might have been transferred.
 =item aio_readahead $fh,$offset,$length, $callback->($retval)
 C<aio_readahead> populates the page cache with data from a file so that
 for an explanation.
 Currently, the stats are always 64-bit-stats, i.e. instead of returning an
 error when stat'ing a large file, the results will be silently truncated
 unless perl itself is compiled with large file support.
+To help interpret the mode and dev/rdev stat values, IO::AIO offers the
+following constants and functions (if not implemented, the constants will
+be C<0> and the functions will either C<croak> or fall back on traditional
+behaviour).
+C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>,
+C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>,
+C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>.
 Example: Print the length of F</etc/passwd>:
    aio_stat "/etc/passwd", sub {
       $_[0] and die "stat failed: $!";
 =item aio_truncate $fh_or_path, $offset, $callback->($status)
 Works like truncate(2) or ftruncate(2).
+=item aio_allocate $fh, $mode, $offset, $len, $callback->($status)
+Allocates or freed disk space according to the C<$mode> argument. See the
+linux C<fallocate> docuemntation for details.
+C<$mode> can currently be C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE>
+to allocate space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE |
+IO::AIO::FALLOC_FL_KEEP_SIZE>, to deallocate a file range.
+The file system block size used by C<fallocate> is presumably the
+C<f_bsize> returned by C<statvfs>.
+If C<fallocate> isn't available or cannot be emulated (currently no
+emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>.
 =item aio_chmod $fh_or_path, $mode, $callback->($status)
 Works like perl's C<chmod> function.
 Asynchronously unlink (delete) a file and call the callback with the
 result code.
-=item aio_mknod $path, $mode, $dev, $callback->($status)
+=item aio_mknod $pathname, $mode, $dev, $callback->($status)
 [EXPERIMENTAL]
 Asynchronously create a device node (or fifo). See mknod(2).
 The only (POSIX-) portable way of calling this function is:
-   aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ...
+   aio_mknod $pathname, IO::AIO::S_IFIFO | $mode, 0, sub { ...
+See C<aio_stat> for info about some potentially helpful extra constants
+and functions.
 =item aio_link $srcpath, $dstpath, $callback->($status)
 Asynchronously create a new link to the existing object at C<$srcpath> at
 the path C<$dstpath> and call the callback with the result code.
 Asynchronously create a new symbolic link to the existing object at C<$srcpath> at
 the path C<$dstpath> and call the callback with the result code.
-=item aio_readlink $path, $callback->($link)
+=item aio_readlink $pathname, $callback->($link)
 Asynchronously read the symlink specified by C<$path> and pass it to
 the callback. If an error occurs, nothing or undef gets passed to the
 callback.
+=item aio_realpath $pathname, $callback->($path)
+Asynchronously make the path absolute and resolve any symlinks in
+C<$path>. The resulting path only consists of directories (Same as
+L<Cwd::realpath>).
+This request can be used to get the absolute path of the current working
+directory by passing it a path of F<.> (a single dot).
 =item aio_rename $srcpath, $dstpath, $callback->($status)
 Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
 rename(2) and call the callback with the result code.
 array-ref with the filenames.
 =item aio_readdirx $pathname, $flags, $callback->($entries, $flags)
-Quite similar to C<aio_readdir>, but the C<$flags> argument allows to tune
+Quite similar to C<aio_readdir>, but the C<$flags> argument allows one to
-behaviour and output format. In case of an error, C<$entries> will be
+tune behaviour and output format. In case of an error, C<$entries> will be
 C<undef>.
 The flags are a combination of the following constants, ORed together (the
 flags will also be passed to the callback, possibly modified):
 =over 4
 =item IO::AIO::READDIR_DENTS
-When this flag is off, then the callback gets an arrayref with of names
+When this flag is off, then the callback gets an arrayref consisting of
-only (as with C<aio_readdir>), otherwise it gets an arrayref with
+names only (as with C<aio_readdir>), otherwise it gets an arrayref with
 C<[$name, $type, $inode]> arrayrefs, each describing a single directory
 entry in more detail.
 C<$name> is the name of the entry.
 systems that do not deliver the inode information.
 =item IO::AIO::READDIR_DIRS_FIRST
 When this flag is set, then the names will be returned in an order where
-likely directories come first. This is useful when you need to quickly
+likely directories come first, in optimal stat order. This is useful when
-find directories, or you want to find all directories while avoiding to
+you need to quickly find directories, or you want to find all directories
-stat() each entry.
+while avoiding to stat() each entry.
 If the system returns type information in readdir, then this is used
-to find directories directly.  Otherwise, likely directories are files
+to find directories directly. Otherwise, likely directories are names
-beginning with ".", or otherwise files with no dots, of which files with
+beginning with ".", or otherwise names with no dots, of which names with
 short names are tried first.
 =item IO::AIO::READDIR_STAT_ORDER
 When this flag is set, then the names will be returned in an order
 =item IO::AIO::READDIR_FOUND_UNKNOWN
 This flag should not be set when calling C<aio_readdirx>. Instead, it
 is being set by C<aio_readdirx>, when any of the C<$type>'s found were
-C<IO::AIO::DT_UNKNOWN>. The absense of this flag therefore indicates that all
+C<IO::AIO::DT_UNKNOWN>. The absence of this flag therefore indicates that all
 C<$type>'s are known, which can be used to speed up some algorithms.
 =back
-=item aio_load $path, $data, $callback->($status)
+=item aio_load $pathname, $data, $callback->($status)
 This is a composite request that tries to fully load the given file into
 memory. Status is the same as with aio_read.
 =cut
       if ($_[0] && $! == EXDEV) {
          aioreq_pri $pri;
          add $grp aio_copy $src, $dst, sub {
             $grp->result ($_[0]);
-            if (!$_[0]) {
+            unless ($_[0]) {
                aioreq_pri $pri;
                add $grp aio_unlink $src;
             }
          };
       } else {
    };
    $grp
 }
-=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
+=item aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
 Scans a directory (similar to C<aio_readdir>) but additionally tries to
 efficiently separate the entries of directory C<$path> into two sets of
 names, directories you can recurse into (directories), and ones you cannot
 recurse into (everything else, including symlinks to directories).
 Then entries will be sorted into likely directories a non-initial dot
 currently) and likely non-directories (see C<aio_readdirx>). Then every
 entry plus an appended C</.> will be C<stat>'ed, likely directories first,
 in order of their inode numbers. If that succeeds, it assumes that the
 entry is a directory or a symlink to directory (which will be checked
-seperately). This is often faster than stat'ing the entry itself because
+separately). This is often faster than stat'ing the entry itself because
 filesystems might detect the type of the entry without reading the inode
 data (e.g. ext2fs filetype feature), even on systems that cannot return
 the filetype information on readdir.
 If the known number of directories (link count - 2) has been reached, the
    my $grp = aio_group $cb;
    $maxreq = 4 if $maxreq <= 0;
-   # stat once
+   # get a wd object
    aioreq_pri $pri;
-   add $grp aio_stat $path, sub {
+   add $grp aio_wd $path, sub {
+      $_[0]
-      return $grp->result () if $_[0];
+         or return $grp->result ();
-      my $now = time;
-      my $hash1 = join ":", (stat _)[0,1,3,7,9];
-      # read the directory entries
+      my $wd = [shift, "."];
+      # stat once
       aioreq_pri $pri;
-      add $grp aio_readdirx $path, READDIR_DIRS_FIRST, sub {
+      add $grp aio_stat $wd, sub {
-         my $entries = shift
-            or return $grp->result ();
+         return $grp->result () if $_[0];
+         my $now = time;
+         my $hash1 = join ":", (stat _)[0,1,3,7,9];
-         # stat the dir another time
+         # read the directory entries
          aioreq_pri $pri;
+         add $grp aio_readdirx $wd, READDIR_DIRS_FIRST, sub {
+            my $entries = shift
+               or return $grp->result ();
+            # stat the dir another time
+            aioreq_pri $pri;
-         add $grp aio_stat $path, sub {
+            add $grp aio_stat $wd, sub {
-            my $hash2 = join ":", (stat _)[0,1,3,7,9];
+               my $hash2 = join ":", (stat _)[0,1,3,7,9];
-            my $ndirs;
+               my $ndirs;
-            # take the slow route if anything looks fishy
+               # take the slow route if anything looks fishy
-            if ($hash1 ne $hash2 or (stat _)[9] == $now) {
+               if ($hash1 ne $hash2 or (stat _)[9] == $now) {
-               $ndirs = -1;
+                  $ndirs = -1;
-            } else {
+               } else {
-               # if nlink == 2, we are finished
+                  # if nlink == 2, we are finished
-               # for non-posix-fs's, we rely on nlink < 2
+                  # for non-posix-fs's, we rely on nlink < 2
-               $ndirs = (stat _)[3] - 2
+                  $ndirs = (stat _)[3] - 2
-                  or return $grp->result ([], $entries);
+                     or return $grp->result ([], $entries);
-            }
+               }
-            my (@dirs, @nondirs);
+               my (@dirs, @nondirs);
-            my $statgrp = add $grp aio_group sub {
+               my $statgrp = add $grp aio_group sub {
-               $grp->result (\@dirs, \@nondirs);
+                  $grp->result (\@dirs, \@nondirs);
-            };
+               };
-            limit $statgrp $maxreq;
+               limit $statgrp $maxreq;
-            feed $statgrp sub {
+               feed $statgrp sub {
-               return unless @$entries;
+                  return unless @$entries;
-               my $entry = shift @$entries;
+                  my $entry = shift @$entries;
-               aioreq_pri $pri;
+                  aioreq_pri $pri;
+                  $wd->[1] = "$entry/.";
-               add $statgrp aio_stat "$path/$entry/.", sub {
+                  add $statgrp aio_stat $wd, sub {
-                  if ($_[0] < 0) {
+                     if ($_[0] < 0) {
-                     push @nondirs, $entry;
+                        push @nondirs, $entry;
-                  } else {
+                     } else {
-                     # need to check for real directory
+                        # need to check for real directory
-                     aioreq_pri $pri;
+                        aioreq_pri $pri;
+                        $wd->[1] = $entry;
-                     add $statgrp aio_lstat "$path/$entry", sub {
+                        add $statgrp aio_lstat $wd, sub {
-                        if (-d _) {
+                           if (-d _) {
-                           push @dirs, $entry;
+                              push @dirs, $entry;
-                           unless (--$ndirs) {
+                              unless (--$ndirs) {
-                              push @nondirs, @$entries;
+                                 push @nondirs, @$entries;
-                              feed $statgrp;
+                                 feed $statgrp;
+                              }
+                           } else {
+                              push @nondirs, $entry;
                            }
-                        } else {
-                           push @nondirs, $entry;
                         }
                      }
-                  }
+                  };
                };
             };
          };
       };
    };
    $grp
 }
-=item aio_rmtree $path, $callback->($status)
+=item aio_rmtree $pathname, $callback->($status)
 Delete a directory tree starting (and including) C<$path>, return the
 status of the final C<rmdir> only.  This is a composite request that
 uses C<aio_scandir> to recurse into and rmdir directories, and unlink
 everything else.
 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_syncfs $fh, $callback->($status)
+Asynchronously call the syncfs syscall to sync the filesystem associated
+to the given filehandle and call the callback with the syncfs result
+code. If syncfs is not available, calls sync(), but returns C<-1> and sets
+errno to C<ENOSYS> nevertheless.
 =item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
 Sync the data portion of the file specified by C<$offset> and C<$length>
 to disk (but NOT the metadata), by calling the Linux-specific
 sync_file_range call. If sync_file_range is not available or it returns
 C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,
 C<IO::AIO::SYNC_FILE_RANGE_WRITE> and
 C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range
 manpage for details.
-=item aio_pathsync $path, $callback->($status)
+=item aio_pathsync $pathname, $callback->($status)
 This request tries to open, fsync and close the given path. This is a
 composite request intended to sync directories after directory operations
 (E.g. rename). This might not work on all operating systems or have any
 specific effect, but usually it makes sure that directory changes get
 as for C<aio_msync>, above, except for flags, which must be either
 C<0> (which reads all pages and ensures they are instantiated) or
 C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and
 writing an octet from it, which dirties the page).
+=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
+This is a rather advanced IO::AIO call, which works best on mmap(2)ed
+scalars.
+It reads in all the pages of the underlying storage into memory (if any)
+and locks them, so they are not getting swapped/paged out or removed.
+If C<$length> is undefined, then the scalar will be locked till the end.
+On systems that do not implement C<mlock>, this function returns C<-1>
+and sets errno to C<ENOSYS>.
+Note that the corresponding C<munlock> is synchronous and is
+documented under L<MISCELLANEOUS FUNCTIONS>.
+Example: open a file, mmap and mlock it - both will be undone when
+C<$data> gets destroyed.
+   open my $fh, "<", $path or die "$path: $!";
+   my $data;
+   IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;
+   aio_mlock $data; # mlock in background
+=item aio_mlockall $flags, $callback->($status)
+Calls the C<mlockall> function with the given C<$flags> (a combination of
+C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>).
+On systems that do not implement C<mlockall>, this function returns C<-1>
+and sets errno to C<ENOSYS>.
+Note that the corresponding C<munlockall> is synchronous and is
+documented under L<MISCELLANEOUS FUNCTIONS>.
+Example: asynchronously lock all current and future pages into memory.
+   aio_mlockall IO::AIO::MCL_FUTURE;
+=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
+Queries the extents of the given file (by calling the Linux FIEMAP ioctl,
+see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If the
+C<ioctl> is not available on your OS, then this request will fail with
+C<ENOSYS>.
+C<$start> is the starting offset to query extents for, C<$length> is the
+size of the range to query - if it is C<undef>, then the whole file will
+be queried.
+C<$flags> is a combination of flags (C<IO::AIO::FIEMAP_FLAG_SYNC> or
+C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also
+exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query
+the data portion.
+C<$count> is the maximum number of extent records to return. If it is
+C<undef>, then IO::AIO queries all extents of the range. As a very special
+case, if it is C<0>, then the callback receives the number of extents
+instead of the extents themselves (which is unreliable, see below).
+If an error occurs, the callback receives no arguments. The special
+C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.
+Otherwise, the callback receives an array reference with extent
+structures. Each extent structure is an array reference itself, with the
+following members:
+   [$logical, $physical, $length, $flags]
+Flags is any combination of the following flag values (typically either C<0>
+or C<IO::AIO::FIEMAP_EXTENT_LAST> (1)):
+C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,
+C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,
+C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,
+C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,
+C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or
+C<IO::AIO::FIEMAP_EXTENT_SHARED>.
+At the time of this writing (Linux 3.2), this requets is unreliable unless
+C<$count> is C<undef>, as the kernel has all sorts of bugs preventing
+it to return all extents of a range for files with large number of
+extents. The code works around all these issues if C<$count> is undef.
 =item aio_group $callback->(...)
 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 with a definite callback
 like sleep and file handle readable/writable, the overhead this creates is
 immense (it blocks a thread for a long time) so do not use this function
 except to put your application under artificial I/O pressure.
 =back
+=head2 IO::AIO::WD - multiple working directories
+Your process only has one current working directory, which is used by all
+threads. This makes it hard to use relative paths (some other component
+could call C<chdir> at any time, and it is hard to control when the path
+will be used by IO::AIO).
+One solution for this is to always use absolute paths. This usually works,
+but can be quite slow (the kernel has to walk the whole path on every
+access), and can also be a hassle to implement.
+Newer POSIX systems have a number of functions (openat, fdopendir,
+futimensat and so on) that make it possible to specify working directories
+per operation.
+For portability, and because the clowns who "designed", or shall I write,
+perpetrated this new interface were obviously half-drunk, this abstraction
+cannot be perfect, though.
+IO::AIO allows you to convert directory paths into a so-called IO::AIO::WD
+object. This object stores the canonicalised, absolute version of the
+path, and on systems that allow it, also a directory file descriptor.
+Everywhere where a pathname is accepted by IO::AIO (e.g. in C<aio_stat>
+or C<aio_unlink>), one can specify an array reference with an IO::AIO::WD
+object and a pathname instead (or the IO::AIO::WD object alone, which
+gets interpreted as C<[$wd, "."]>). If the pathname is absolute, the
+IO::AIO::WD object is ignored, otherwise the pathname is resolved relative
+to that IO::AIO::WD object.
+For example, to get a wd object for F</etc> and then stat F<passwd>
+inside, you would write:
+   aio_wd "/etc", sub {
+      my $etcdir = shift;
+      # although $etcdir can be undef on error, there is generally no reason
+      # to check for errors here, as aio_stat will fail with ENOENT
+      # when $etcdir is undef.
+      aio_stat [$etcdir, "passwd"], sub {
+         # yay
+      };
+   };
+That C<aio_wd> is a request and not a normal function shows that creating
+an IO::AIO::WD object is itself a potentially blocking operation, which is
+why it is done asynchronously.
+To stat the directory obtained with C<aio_wd> above, one could write
+either of the following three request calls:
+   aio_lstat "/etc"    , sub { ...  # pathname as normal string
+   aio_lstat [$wd, "."], sub { ...  # "." relative to $wd (i.e. $wd itself)
+   aio_lstat $wd       , sub { ...  # shorthand for the previous
+As with normal pathnames, IO::AIO keeps a copy of the working directory
+object and the pathname string, so you could write the following without
+causing any issues due to C<$path> getting reused:
+   my $path = [$wd, undef];
+   for my $name (qw(abc def ghi)) {
+      $path->[1] = $name;
+      aio_stat $path, sub {
+         # ...
+      };
+   }
+There are some caveats: when directories get renamed (or deleted), the
+pathname string doesn't change, so will point to the new directory (or
+nowhere at all), while the directory fd, if available on the system,
+will still point to the original directory. Most functions accepting a
+pathname will use the directory fd on newer systems, and the string on
+older systems. Some functions (such as realpath) will always rely on the
+string form of the pathname.
+So this fucntionality is mainly useful to get some protection against
+C<chdir>, to easily get an absolute path out of a relative path for future
+reference, and to speed up doing many operations in the same directory
+(e.g. when stat'ing all files in a directory).
+The following functions implement this working directory abstraction:
+=over 4
+=item aio_wd $pathname, $callback->($wd)
+Asynchonously canonicalise the given pathname and convert it to an
+IO::AIO::WD object representing it. If possible and supported on the
+system, also open a directory fd to speed up pathname resolution relative
+to this working directory.
+If something goes wrong, then C<undef> is passwd to the callback instead
+of a working directory object and C<$!> is set appropriately. Since
+passing C<undef> as working directory component of a pathname fails the
+request with C<ENOENT>, there is often no need for error checking in the
+C<aio_wd> callback, as future requests using the value will fail in the
+expected way.
+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 IO::AIO::CWD
+This is a compiletime constant (object) that represents the process
+current working directory.
+Specifying this object as working directory object for a pathname is as
+if the pathname would be specified directly, without a directory object,
+e.g., these calls are functionally identical:
+   aio_stat "somefile", sub { ... };
+   aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
+=back
 =head2 IO::AIO::REQ CLASS
 All non-aggregate C<aio_*> functions return an object of this class when
 called in non-void context.
 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,
+C<aio_scandir> might generate hundreds of thousands of C<aio_stat>
-delaying any later requests for a long time.
+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
 feed callback will be called whenever there are few enough (see C<limit>,
 below) requests active in the group itself and is expected to queue more
 See C<poll_cb> for an example.
 =item IO::AIO::poll_cb
-Process some outstanding events on the result pipe. You have to call this
+Process some outstanding events on the result pipe. You have to call
-regularly. Returns C<0> if all events could be processed, or C<-1> if it
+this regularly. Returns C<0> if all events could be processed (or there
-returned earlier for whatever reason. Returns immediately when no events
+were no events to process), or C<-1> if it returned earlier for whatever
-are outstanding. The amount of events processed depends on the settings of
+reason. Returns immediately when no events are outstanding. The amount of
-C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.
+events processed depends on the settings of C<IO::AIO::max_poll_req> and
+C<IO::AIO::max_poll_time>.
 If not all requests were processed for whatever reason, the filehandle
 will still be ready when C<poll_cb> returns, so normally you don't have to
 do anything special to have it called later.
+Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes
+ready, it can be beneficial to call this function from loops which submit
+a lot of requests, to make sure the results get processed when they become
+available and not just when the loop is finished and the event loop takes
+over again. This function returns very fast when there are no outstanding
+requests.
 Example: Install an Event watcher that automatically calls
 IO::AIO::poll_cb with high priority (more examples can be found in the
 SYNOPSIS section, at the top of this document):
 Under normal circumstances you don't need to call this function.
 =item IO::AIO::max_idle $nthreads
-Limit the number of threads (default: 4) that are allowed to idle (i.e.,
+Limit the number of threads (default: 4) that are allowed to idle
-threads that did not get a request to process within 10 seconds). That
+(i.e., threads that did not get a request to process within the idle
-means if a thread becomes idle while C<$nthreads> other threads are also
+timeout (default: 10 seconds). That means if a thread becomes idle while
-idle, it will free its resources and exit.
+C<$nthreads> other threads are also idle, it will free its resources and
+exit.
 This is useful when you allow a large number of threads (e.g. 100 or 1000)
 to allow for extremely high load situations, but want to free resources
 under normal circumstances (1000 threads can easily consume 30MB of RAM).
 The default is probably ok in most situations, especially if thread
 creation is fast. If thread creation is very slow on your system you might
 want to use larger values.
+=item IO::AIO::idle_timeout $seconds
+Sets the minimum idle timeout (default 10) after which worker threads are
+allowed to exit. SEe C<IO::AIO::max_idle>.
 =item IO::AIO::max_outstanding $maxreqs
+Sets the maximum number of outstanding requests to C<$nreqs>. If
+you do queue up more than this number of requests, the next call to
+C<IO::AIO::poll_cb> (and other functions calling C<poll_cb>, such as
+C<IO::AIO::flush> or C<IO::AIO::poll>) will block until the limit is no
+longer exceeded.
+In other words, this setting does not enforce a queue limit, but can be
+used to make poll functions block if the limit is exceeded.
 This is a very bad function to use in interactive programs because it
 blocks, and a bad way to reduce concurrency because it is inexact: Better
 use an C<aio_group> together with a feed callback.
-Sets the maximum number of outstanding requests to C<$nreqs>. If you
+It's main use is in scripts without an event loop - when you want to stat
-do queue up more than this number of requests, the next call to the
+a lot of files, you can write somehting like this:
-C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)
-function will block until the limit is no longer exceeded.
-The default value is very large, so there is no practical limit on the
+   IO::AIO::max_outstanding 32;
-number of outstanding requests.
-You can still queue as many requests as you want. Therefore,
+   for my $path (...) {
-C<max_outstanding> is mainly useful in simple scripts (with low values) or
+      aio_stat $path , ...;
-as a stop gap to shield against fatal memory overflow (with large values).
+      IO::AIO::poll_cb;
+   }
+   IO::AIO::flush;
+The call to C<poll_cb> inside the loop will normally return instantly, but
+as soon as more thna C<32> reqeusts are in-flight, it will block until
+some requests have been handled. This keeps the loop from pushing a large
+number of C<aio_stat> requests onto the queue.
+The default value for C<max_outstanding> is very large, so there is no
+practical limit on the number of outstanding requests.
 =back
 =head3 STATISTICAL INFORMATION
 Returns the number of bytes copied, or C<-1> on error.
 =item IO::AIO::fadvise $fh, $offset, $len, $advice
-Simply calls the C<posix_fadvise> function (see it's
+Simply calls the C<posix_fadvise> function (see its
 manpage for details). The following advice constants are
-avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,
+available: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,
 C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>,
 C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.
 On systems that do not implement C<posix_fadvise>, this function returns
 ENOSYS, otherwise the return value of C<posix_fadvise>.
+=item IO::AIO::madvise $scalar, $offset, $len, $advice
+Simply calls the C<posix_madvise> function (see its
+manpage for details). The following advice constants are
+available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
+C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>.
+On systems that do not implement C<posix_madvise>, this function returns
+ENOSYS, otherwise the return value of C<posix_madvise>.
+=item IO::AIO::mprotect $scalar, $offset, $len, $protect
+Simply calls the C<mprotect> function on the preferably AIO::mmap'ed
+$scalar (see its manpage for details). The following protect
+constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,
+C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.
+On systems that do not implement C<mprotect>, this function returns
+ENOSYS, otherwise the return value of C<mprotect>.
 =item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
 Memory-maps a file (or anonymous memory range) and attaches it to the
-given C<$scalar>, which will act like a string scalar.
+given C<$scalar>, which will act like a string scalar. Returns true on
+success, and false otherwise.
 The only operations allowed on the scalar are C<substr>/C<vec> that don't
 change the string length, and most read-only operations such as copying it
 or searching it with regexes and so on.
 =item IO::AIO::munmap $scalar
 Removes a previous mmap and undefines the C<$scalar>.
-=item IO::AIO::mlockall $flags
+=item IO::AIO::munlock $scalar, $offset = 0, $length = undef
-Calls the C<mlockall> function with the given C<$flags> (a combination of
+Calls the C<munlock> function, undoing the effects of a previous
-C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL__FUTURE>).
+C<aio_mlock> call (see its description for details).
-On systems that do not implement C<mlockall>, this function returns
-ENOSYS, otherwise the return value of C<mlockall>.
 =item IO::AIO::munlockall
 Calls the C<munlockall> function.
 On systems that do not implement C<munlockall>, this function returns
 ENOSYS, otherwise the return value of C<munlockall>.
+=item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
+Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or
+C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they
+should be the file offset.
+C<$r_fh> and C<$w_fh> should not refer to the same file, as splice might
+silently corrupt the data in this case.
+The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>,
+C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and
+C<IO::AIO::SPLICE_F_GIFT>.
+See the C<splice(2)> manpage for details.
+=item IO::AIO::tee $r_fh, $w_fh, $length, $flags
+Calls the GNU/Linux C<tee(2)> syscall, see it's manpage and the
+description for C<IO::AIO::splice> above for details.
 =back
 =cut
  Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
                              \&IO::AIO::poll_cb);
 =head2 FORK BEHAVIOUR
-This module should do "the right thing" when the process using it forks:
+Usage of pthreads in a program changes the semantics of fork
+considerably. Specifically, only async-safe functions can be called after
+fork. Perl doesn't know about this, so in general, you cannot call fork
+with defined behaviour in perl if pthreads are involved. IO::AIO uses
+pthreads, so this applies, but many other extensions and (for inexplicable
+reasons) perl itself often is linked against pthreads, so this limitation
+applies to quite a lot of perls.
-Before the fork, IO::AIO enters a quiescent state where no requests
+This module no longer tries to fight your OS, or POSIX. That means IO::AIO
-can be added in other threads and no results will be processed. After
+only works in the process that loaded it. Forking is fully supported, but
-the fork the parent simply leaves the quiescent state and continues
+using IO::AIO in the child is not.
-request/result processing, while the child frees the request/result queue
-(so that the requests started before the fork will only be handled in the
-parent). Threads will be started on demand until the limit set in the
-parent process has been reached again.
-In short: the parent will, after a short pause, continue as if fork had
+You might get around by not I<using> IO::AIO before (or after)
-not been called, while the child will act as if IO::AIO has not been used
+forking. You could also try to call the L<IO::AIO::reinit> function in the
-yet.
+child:
+=over 4
+=item IO::AIO::reinit
+Abandons all current requests and I/O threads and simply reinitialises all
+data structures. This is not an operation supported by any standards, but
+happens to work on GNU/Linux and some newer BSD systems.
+The only reasonable use for this function is to call it after forking, if
+C<IO::AIO> was used in the parent. Calling it while IO::AIO is active in
+the process will result in undefined behaviour. Calling it at any time
+will also result in any undefined (by POSIX) behaviour.
+=back
 =head2 MEMORY USAGE
 Per-request usage:

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.181 by root, Tue May 4 21:14:01 2010 UTC vs. Revision 1.232 by root, Mon Jul 30 16:46:30 2012 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.181 by root, Tue May 4 21:14:01 2010 UTC vs.
Revision 1.232 by root, Mon Jul 30 16:46:30 2012 UTC