--- IO-AIO/AIO.pm	2015/06/25 13:34:28	1.253
+++ IO-AIO/AIO.pm	2016/08/09 11:39:17	1.267
@@ -1,6 +1,6 @@
 =head1 NAME
 
-IO::AIO - Asynchronous Input/Output
+IO::AIO - Asynchronous/Advanced Input/Output
 
 =head1 SYNOPSIS
 
@@ -60,6 +60,10 @@
 aio_write, so the remaining functionality would have to be implemented
 using threads anyway.
 
+In addition to asynchronous I/O, this module also exports some rather
+arcane interfaces, such as C<madvise> or linux's C<splice> system call,
+which is why the C<A> in C<AIO> can also mean I<advanced>.
+
 Although the module will work in the presence of other (Perl-) threads,
 it is currently not reentrant in any way, so use appropriate locking
 yourself, always call C<poll_cb> from within the same thread, or never
@@ -96,7 +100,7 @@
          print $contents;
 
          # exit event loop and program
-         EV::unloop;
+         EV::break;
       };
    };
 
@@ -104,7 +108,7 @@
    # check for sockets etc. etc.
 
    # process events as long as there are some:
-   EV::loop;
+   EV::run;
 
 =head1 REQUEST ANATOMY AND LIFETIME
 
@@ -169,13 +173,13 @@
 use base 'Exporter';
 
 BEGIN {
-   our $VERSION = 4.32;
+   our $VERSION = 4.34;
 
    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_realpath aio_sync
-                     aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_allocate
-                     aio_pathsync aio_readahead aio_fiemap
+                     aio_scandir aio_symlink aio_readlink aio_realpath aio_fcntl aio_ioctl
+                     aio_sync aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range
+                     aio_pathsync aio_readahead aio_fiemap aio_allocate
                      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
@@ -242,6 +246,8 @@
    aio_copy $srcpath, $dstpath, $callback->($status)
    aio_move $srcpath, $dstpath, $callback->($status)
    aio_rmtree $pathname, $callback->($status)
+   aio_fcntl $fh, $cmd, $arg, $callback->($status)
+   aio_ioctl $fh, $request, $buf, $callback->($status)
    aio_sync $callback->($status)
    aio_syncfs $fh, $callback->($status)
    aio_fsync $fh, $callback->($status)
@@ -396,7 +402,7 @@
 
 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>.
+C<O_RSYNC>, C<O_SYNC>, C<O_PATH>, C<O_TMPFILE>, and C<O_TTY_INIT>.
 
 
 =item aio_close $fh, $callback->($status)
@@ -441,8 +447,8 @@
 =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
 
 Reads or writes C<$length> bytes from or to the specified C<$fh> and
-C<$offset> into the scalar given by C<$data> and offset C<$dataoffset>
-and calls the callback without the actual number of bytes read (or -1 on
+C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> and
+calls the callback with the actual number of bytes transferred (or -1 on
 error, just like the syscall).
 
 C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to
@@ -510,7 +516,7 @@
 on many systems, this implementation tries to work around some known bugs
 in Linux and FreeBSD kernels (probably others, too), but that might fail,
 so you really really should check the return value of C<aio_sendfile> -
-fewre bytes than expected might have been transferred.
+fewer bytes than expected might have been transferred.
 
 
 =item aio_readahead $fh,$offset,$length, $callback->($retval)
@@ -524,8 +530,8 @@
 (off-set+length). C<aio_readahead> does not read beyond the end of the
 file. The current file offset of the file is left unchanged.
 
-If that syscall doesn't exist (likely if your OS isn't Linux) it will be
-emulated by simply reading the data, which would have a similar effect.
+If that syscall doesn't exist (likely if your kernel isn't Linux) it will
+be emulated by simply reading the data, which would have a similar effect.
 
 
 =item aio_stat  $fh_or_path, $callback->($status)
@@ -628,8 +634,9 @@
    0x0000f15f ecryptfs
    0x00414a53 efs
    0x0000137d ext
-   0x0000ef53 ext2/ext3
+   0x0000ef53 ext2/ext3/ext4
    0x0000ef51 ext2
+   0xf2f52010 f2fs
    0x00004006 fat
    0x65735546 fuseblk
    0x65735543 fusectl
@@ -638,6 +645,7 @@
    0x47504653 gpfs
    0x00004244 hfs
    0xf995e849 hpfs
+   0x00c0ffee hostfs
    0x958458f6 hugetlbfs
    0x2bad1dea inotifyfs
    0x00009660 isofs
@@ -662,6 +670,7 @@
    0x00009fa0 proc
    0x6165676c pstorefs
    0x0000002f qnx4
+   0x68191122 qnx6
    0x858458f6 ramfs
    0x52654973 reiserfs
    0x00007275 romfs
@@ -1226,6 +1235,46 @@
    $grp
 }
 
+=item aio_fcntl $fh, $cmd, $arg, $callback->($status)
+
+=item aio_ioctl $fh, $request, $buf, $callback->($status)
+
+These work just like the C<fcntl> and C<ioctl> built-in functions, except
+they execute asynchronously and pass the return value to the callback.
+
+Both calls can be used for a lot of things, some of which make more sense
+to run asynchronously in their own thread, while some others make less
+sense. For example, calls that block waiting for external events, such
+as locking, will also lock down an I/O thread while it is waiting, which
+can deadlock the whole I/O system. At the same time, there might be no
+alternative to using a thread to wait.
+
+So in general, you should only use these calls for things that do
+(filesystem) I/O, not for things that wait for other events (network,
+other processes), although if you are careful and know what you are doing,
+you still can.
+
+The following constants are available (missing ones are, as usual C<0>):
+
+C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>.
+
+C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>,
+C<FS_IOC_FIEMAP>.
+
+C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>,
+C<FS_IOC_GET_ENCRYPTION_PWSALT>, C<FS_IOC_GET_ENCRYPTION_POLICY>, C<FS_KEY_DESCRIPTOR_SIZE>.
+
+C<FS_SECRM_FL>, C<FS_UNRM_FL>, C<FS_COMPR_FL>, C<FS_SYNC_FL>, C<FS_IMMUTABLE_FL>,
+C<FS_APPEND_FL>, C<FS_NODUMP_FL>, C<FS_NOATIME_FL>, C<FS_DIRTY_FL>,
+C<FS_COMPRBLK_FL>, C<FS_NOCOMP_FL>, C<FS_ENCRYPT_FL>, C<FS_BTREE_FL>,
+C<FS_INDEX_FL>, C<FS_JOURNAL_DATA_FL>, C<FS_NOTAIL_FL>, C<FS_DIRSYNC_FL>, C<FS_TOPDIR_FL>,
+C<FS_FL_USER_MODIFIABLE>.
+
+C<FS_XFLAG_REALTIME>, C<FS_XFLAG_PREALLOC>, C<FS_XFLAG_IMMUTABLE>, C<FS_XFLAG_APPEND>,
+C<FS_XFLAG_SYNC>, C<FS_XFLAG_NOATIME>, C<FS_XFLAG_NODUMP>, C<FS_XFLAG_RTINHERIT>,
+C<FS_XFLAG_PROJINHERIT>, C<FS_XFLAG_NOSYMLINKS>, C<FS_XFLAG_EXTSIZE>, C<FS_XFLAG_EXTSZINHERIT>,
+C<FS_XFLAG_NODEFRAG>, C<FS_XFLAG_FILESTREAM>, C<FS_XFLAG_DAX>, C<FS_XFLAG_HASATTR>,
+
 =item aio_sync $callback->($status)
 
 Asynchronously call sync and call the callback when finished.
@@ -2019,7 +2068,8 @@
 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>.
+C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>,
+C<IO::AIO::MADV_FREE>.
 
 On systems that do not implement C<posix_madvise>, this function returns
 ENOSYS, otherwise the return value of C<posix_madvise>.
@@ -2059,13 +2109,20 @@
 C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,
 C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,
 
-C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or
-C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when
-not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS>
-(which is set to C<MAP_ANON> if your system only provides this
-constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>,
-C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or
-C<IO::AIO::MAP_NONBLOCK>
+C<$flags> can be a combination of
+C<IO::AIO::MAP_SHARED> or
+C<IO::AIO::MAP_PRIVATE>,
+or a number of system-specific flags (when not available, the are C<0>):
+C<IO::AIO::MAP_ANONYMOUS> (which is set to C<MAP_ANON> if your system only provides this constant),
+C<IO::AIO::MAP_LOCKED>,
+C<IO::AIO::MAP_NORESERVE>,
+C<IO::AIO::MAP_POPULATE>,
+C<IO::AIO::MAP_NONBLOCK>,
+C<IO::AIO::MAP_FIXED>,
+C<IO::AIO::MAP_GROWSDOWN>,
+C<IO::AIO::MAP_32BIT>,
+C<IO::AIO::MAP_HUGETLB> or
+C<IO::AIO::MAP_STACK>.
 
 If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
 
@@ -2132,8 +2189,9 @@
 
 This is a direct interface to the Linux L<pipe2(2)> system call. If
 C<$flags> is missing or C<0>, then this should be the same as a call to
-perl's built-in C<pipe> function and create a new pipe, and should work
-everywhere.
+perl's built-in C<pipe> function and create a new pipe, and works on
+systems that lack the pipe2 syscall. On win32, this case invokes C<_pipe
+(..., 4096, O_BINARY)>.
 
 If C<$flags> is non-zero, it tries to invoke the pipe2 system call with
 the given flags (Linux 2.6.27, glibc 2.9).