… | |
… | |
178 | our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close |
178 | our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close |
179 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx |
179 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx |
180 | aio_scandir aio_symlink aio_readlink aio_realpath aio_fcntl aio_ioctl |
180 | aio_scandir aio_symlink aio_readlink aio_realpath aio_fcntl aio_ioctl |
181 | aio_sync aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range |
181 | aio_sync aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range |
182 | aio_pathsync aio_readahead aio_fiemap aio_allocate |
182 | aio_pathsync aio_readahead aio_fiemap aio_allocate |
183 | aio_rename aio_link aio_move aio_copy aio_group |
183 | aio_rename aio_rename2 aio_link aio_move aio_copy aio_group |
184 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
184 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
185 | aio_chmod aio_utime aio_truncate |
185 | aio_chmod aio_utime aio_truncate |
186 | aio_msync aio_mtouch aio_mlock aio_mlockall |
186 | aio_msync aio_mtouch aio_mlock aio_mlockall |
187 | aio_statvfs |
187 | aio_statvfs |
188 | aio_wd); |
188 | aio_wd); |
… | |
… | |
233 | aio_link $srcpath, $dstpath, $callback->($status) |
233 | aio_link $srcpath, $dstpath, $callback->($status) |
234 | aio_symlink $srcpath, $dstpath, $callback->($status) |
234 | aio_symlink $srcpath, $dstpath, $callback->($status) |
235 | aio_readlink $pathname, $callback->($link) |
235 | aio_readlink $pathname, $callback->($link) |
236 | aio_realpath $pathname, $callback->($path) |
236 | aio_realpath $pathname, $callback->($path) |
237 | aio_rename $srcpath, $dstpath, $callback->($status) |
237 | aio_rename $srcpath, $dstpath, $callback->($status) |
|
|
238 | aio_rename2 $srcpath, $dstpath, $flags, $callback->($status) |
238 | aio_mkdir $pathname, $mode, $callback->($status) |
239 | aio_mkdir $pathname, $mode, $callback->($status) |
239 | aio_rmdir $pathname, $callback->($status) |
240 | aio_rmdir $pathname, $callback->($status) |
240 | aio_readdir $pathname, $callback->($entries) |
241 | aio_readdir $pathname, $callback->($entries) |
241 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
242 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
242 | IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST |
243 | IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST |
… | |
… | |
276 | IO::AIO::idle_timeout $seconds |
277 | IO::AIO::idle_timeout $seconds |
277 | IO::AIO::max_outstanding $maxreqs |
278 | IO::AIO::max_outstanding $maxreqs |
278 | IO::AIO::nreqs |
279 | IO::AIO::nreqs |
279 | IO::AIO::nready |
280 | IO::AIO::nready |
280 | IO::AIO::npending |
281 | IO::AIO::npending |
|
|
282 | IO::AIO::min_fdlimit $nfd; |
281 | |
283 | |
282 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
284 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
283 | IO::AIO::fadvise $fh, $offset, $len, $advice |
285 | IO::AIO::fadvise $fh, $offset, $len, $advice |
284 | IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]] |
286 | IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]] |
285 | IO::AIO::munmap $scalar |
287 | IO::AIO::munmap $scalar |
… | |
… | |
739 | C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate |
741 | C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate |
740 | space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE | IO::AIO::FALLOC_FL_KEEP_SIZE>, |
742 | space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE | IO::AIO::FALLOC_FL_KEEP_SIZE>, |
741 | to deallocate a file range. |
743 | to deallocate a file range. |
742 | |
744 | |
743 | IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range |
745 | IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range |
744 | (without leaving a hole) and C<FALLOC_FL_ZERO_RANGE>, to zero a range (see |
746 | (without leaving a hole), C<FALLOC_FL_ZERO_RANGE>, to zero a range, |
745 | your L<fallocate(2)> manpage). |
747 | C<FALLOC_FL_INSERT_RANGE> to insert a range and C<FALLOC_FL_UNSHARE_RANGE> |
|
|
748 | to unshare shared blocks (see your L<fallocate(2)> manpage). |
746 | |
749 | |
747 | The file system block size used by C<fallocate> is presumably the |
750 | The file system block size used by C<fallocate> is presumably the |
748 | C<f_bsize> returned by C<statvfs>. |
751 | C<f_bsize> returned by C<statvfs>, but different filesystems and filetypes |
|
|
752 | can dictate other limitations. |
749 | |
753 | |
750 | If C<fallocate> isn't available or cannot be emulated (currently no |
754 | If C<fallocate> isn't available or cannot be emulated (currently no |
751 | emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>. |
755 | emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>. |
752 | |
756 | |
753 | |
757 | |
… | |
… | |
810 | rename(2) and call the callback with the result code. |
814 | rename(2) and call the callback with the result code. |
811 | |
815 | |
812 | On systems that support the AIO::WD working directory abstraction |
816 | On systems that support the AIO::WD working directory abstraction |
813 | natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead |
817 | natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead |
814 | of failing, C<rename> is called on the absolute path of C<$wd>. |
818 | of failing, C<rename> is called on the absolute path of C<$wd>. |
|
|
819 | |
|
|
820 | |
|
|
821 | =item aio_rename2 $srcpath, $dstpath, $flags, $callback->($status) |
|
|
822 | |
|
|
823 | Basically a version of C<aio_rename> with an additional C<$flags> |
|
|
824 | argument. Calling this with C<$flags=0> is the same as calling |
|
|
825 | C<aio_rename>. |
|
|
826 | |
|
|
827 | Non-zero flags are currently only supported on GNU/Linux systems that |
|
|
828 | support renameat2. Other systems fail with C<ENOSYS> in this case. |
|
|
829 | |
|
|
830 | The following constants are available (missing ones are, as usual C<0>), |
|
|
831 | see renameat2(2) for details: |
|
|
832 | |
|
|
833 | C<IO::AIO::RENAME_NOREPLACE>, C<IO::AIO::RENAME_EXCHANGE> |
|
|
834 | and C<IO::AIO::RENAME_WHITEOUT>. |
815 | |
835 | |
816 | |
836 | |
817 | =item aio_mkdir $pathname, $mode, $callback->($status) |
837 | =item aio_mkdir $pathname, $mode, $callback->($status) |
818 | |
838 | |
819 | Asynchronously mkdir (create) a directory and call the callback with |
839 | Asynchronously mkdir (create) a directory and call the callback with |
… | |
… | |
938 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
958 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
939 | |
959 | |
940 | Try to copy the I<file> (directories not supported as either source or |
960 | Try to copy the I<file> (directories not supported as either source or |
941 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
961 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
942 | a status of C<0> (ok) or C<-1> (error, see C<$!>). |
962 | a status of C<0> (ok) or C<-1> (error, see C<$!>). |
|
|
963 | |
|
|
964 | Existing destination files will be truncated. |
943 | |
965 | |
944 | This is a composite request that creates the destination file with |
966 | This is a composite request that creates the destination file with |
945 | mode 0200 and copies the contents of the source file into it using |
967 | mode 0200 and copies the contents of the source file into it using |
946 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
968 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
947 | uid/gid, in that order. |
969 | uid/gid, in that order. |
… | |
… | |
1057 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
1079 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
1058 | efficiently separate the entries of directory C<$path> into two sets of |
1080 | efficiently separate the entries of directory C<$path> into two sets of |
1059 | names, directories you can recurse into (directories), and ones you cannot |
1081 | names, directories you can recurse into (directories), and ones you cannot |
1060 | recurse into (everything else, including symlinks to directories). |
1082 | recurse into (everything else, including symlinks to directories). |
1061 | |
1083 | |
1062 | C<aio_scandir> is a composite request that creates of many sub requests_ |
1084 | C<aio_scandir> is a composite request that generates many sub requests. |
1063 | C<$maxreq> specifies the maximum number of outstanding aio requests that |
1085 | C<$maxreq> specifies the maximum number of outstanding aio requests that |
1064 | this function generates. If it is C<< <= 0 >>, then a suitable default |
1086 | this function generates. If it is C<< <= 0 >>, then a suitable default |
1065 | will be chosen (currently 4). |
1087 | will be chosen (currently 4). |
1066 | |
1088 | |
1067 | On error, the callback is called without arguments, otherwise it receives |
1089 | On error, the callback is called without arguments, otherwise it receives |
… | |
… | |
1254 | other processes), although if you are careful and know what you are doing, |
1276 | other processes), although if you are careful and know what you are doing, |
1255 | you still can. |
1277 | you still can. |
1256 | |
1278 | |
1257 | The following constants are available (missing ones are, as usual C<0>): |
1279 | The following constants are available (missing ones are, as usual C<0>): |
1258 | |
1280 | |
|
|
1281 | C<F_DUPFD_CLOEXEC>, |
|
|
1282 | |
|
|
1283 | C<F_OFD_GETLK>, C<F_OFD_SETLK>, C<F_OFD_GETLKW>, |
|
|
1284 | |
1259 | C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>. |
1285 | C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>. |
1260 | |
1286 | |
1261 | C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>, |
1287 | C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>, |
1262 | C<FS_IOC_FIEMAP>. |
1288 | C<FS_IOC_FIEMAP>. |
1263 | |
1289 | |
… | |
… | |
1582 | There are some caveats: when directories get renamed (or deleted), the |
1608 | There are some caveats: when directories get renamed (or deleted), the |
1583 | pathname string doesn't change, so will point to the new directory (or |
1609 | pathname string doesn't change, so will point to the new directory (or |
1584 | nowhere at all), while the directory fd, if available on the system, |
1610 | nowhere at all), while the directory fd, if available on the system, |
1585 | will still point to the original directory. Most functions accepting a |
1611 | will still point to the original directory. Most functions accepting a |
1586 | pathname will use the directory fd on newer systems, and the string on |
1612 | pathname will use the directory fd on newer systems, and the string on |
1587 | older systems. Some functions (such as realpath) will always rely on the |
1613 | older systems. Some functions (such as C<aio_realpath>) will always rely on |
1588 | string form of the pathname. |
1614 | the string form of the pathname. |
1589 | |
1615 | |
1590 | So this functionality is mainly useful to get some protection against |
1616 | So this functionality is mainly useful to get some protection against |
1591 | C<chdir>, to easily get an absolute path out of a relative path for future |
1617 | C<chdir>, to easily get an absolute path out of a relative path for future |
1592 | reference, and to speed up doing many operations in the same directory |
1618 | reference, and to speed up doing many operations in the same directory |
1593 | (e.g. when stat'ing all files in a directory). |
1619 | (e.g. when stat'ing all files in a directory). |
… | |
… | |
1985 | This is a very bad function to use in interactive programs because it |
2011 | This is a very bad function to use in interactive programs because it |
1986 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
2012 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1987 | use an C<aio_group> together with a feed callback. |
2013 | use an C<aio_group> together with a feed callback. |
1988 | |
2014 | |
1989 | Its main use is in scripts without an event loop - when you want to stat |
2015 | Its main use is in scripts without an event loop - when you want to stat |
1990 | a lot of files, you can write somehting like this: |
2016 | a lot of files, you can write something like this: |
1991 | |
2017 | |
1992 | IO::AIO::max_outstanding 32; |
2018 | IO::AIO::max_outstanding 32; |
1993 | |
2019 | |
1994 | for my $path (...) { |
2020 | for my $path (...) { |
1995 | aio_stat $path , ...; |
2021 | aio_stat $path , ...; |
… | |
… | |
2040 | some "Advanced I/O" function not available to in Perl, without going the |
2066 | some "Advanced I/O" function not available to in Perl, without going the |
2041 | "Asynchronous I/O" route. Many of these have an asynchronous C<aio_*> |
2067 | "Asynchronous I/O" route. Many of these have an asynchronous C<aio_*> |
2042 | counterpart. |
2068 | counterpart. |
2043 | |
2069 | |
2044 | =over 4 |
2070 | =over 4 |
|
|
2071 | |
|
|
2072 | =item $numfd = IO::AIO::get_fdlimit |
|
|
2073 | |
|
|
2074 | Tries to find the current file descriptor limit and returns it, or |
|
|
2075 | C<undef> and sets C<$!> in case of an error. The limit is one larger than |
|
|
2076 | the highest valid file descriptor number. |
|
|
2077 | |
|
|
2078 | =item IO::AIO::min_fdlimit [$numfd] |
|
|
2079 | |
|
|
2080 | Try to increase the current file descriptor limit(s) to at least C<$numfd> |
|
|
2081 | by changing the soft or hard file descriptor resource limit. If C<$numfd> |
|
|
2082 | is missing, it will try to set a very high limit, although this is not |
|
|
2083 | recommended when you know the actual minimum that you require. |
|
|
2084 | |
|
|
2085 | If the limit cannot be raised enough, the function makes a best-effort |
|
|
2086 | attempt to increase the limit as much as possible, using various |
|
|
2087 | tricks, while still failing. You can query the resulting limit using |
|
|
2088 | C<IO::AIO::get_fdlimit>. |
|
|
2089 | |
|
|
2090 | If an error occurs, returns C<undef> and sets C<$!>, otherwise returns |
|
|
2091 | true. |
2045 | |
2092 | |
2046 | =item IO::AIO::sendfile $ofh, $ifh, $offset, $count |
2093 | =item IO::AIO::sendfile $ofh, $ifh, $offset, $count |
2047 | |
2094 | |
2048 | Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>, |
2095 | Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>, |
2049 | but is blocking (this makes most sense if you know the input data is |
2096 | but is blocking (this makes most sense if you know the input data is |
… | |
… | |
2066 | =item IO::AIO::madvise $scalar, $offset, $len, $advice |
2113 | =item IO::AIO::madvise $scalar, $offset, $len, $advice |
2067 | |
2114 | |
2068 | Simply calls the C<posix_madvise> function (see its |
2115 | Simply calls the C<posix_madvise> function (see its |
2069 | manpage for details). The following advice constants are |
2116 | manpage for details). The following advice constants are |
2070 | available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, |
2117 | available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, |
2071 | C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>, |
2118 | C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, |
2072 | C<IO::AIO::MADV_FREE>. |
2119 | C<IO::AIO::MADV_DONTNEED>. |
2073 | |
2120 | |
2074 | If C<$offset> is negative, counts from the end. If C<$length> is negative, |
2121 | If C<$offset> is negative, counts from the end. If C<$length> is negative, |
2075 | the remaining length of the C<$scalar> is used. If possible, C<$length> |
2122 | the remaining length of the C<$scalar> is used. If possible, C<$length> |
2076 | will be reduced to fit into the C<$scalar>. |
2123 | will be reduced to fit into the C<$scalar>. |
2077 | |
2124 | |