… | |
… | |
68 | =head2 EXAMPLE |
68 | =head2 EXAMPLE |
69 | |
69 | |
70 | This is a simple example that uses the EV module and loads |
70 | This is a simple example that uses the EV module and loads |
71 | F</etc/passwd> asynchronously: |
71 | F</etc/passwd> asynchronously: |
72 | |
72 | |
73 | use Fcntl; |
|
|
74 | use EV; |
73 | use EV; |
75 | use IO::AIO; |
74 | use IO::AIO; |
76 | |
75 | |
77 | # register the IO::AIO callback with EV |
76 | # register the IO::AIO callback with EV |
78 | my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; |
77 | my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; |
… | |
… | |
168 | use common::sense; |
167 | use common::sense; |
169 | |
168 | |
170 | use base 'Exporter'; |
169 | use base 'Exporter'; |
171 | |
170 | |
172 | BEGIN { |
171 | BEGIN { |
173 | our $VERSION = '4.18'; |
172 | our $VERSION = 4.32; |
174 | |
173 | |
175 | our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close |
174 | our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close |
176 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx |
175 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx |
177 | aio_scandir aio_symlink aio_readlink aio_realpath aio_sync |
176 | aio_scandir aio_symlink aio_readlink aio_realpath aio_sync |
178 | aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_allocate |
177 | aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_allocate |
… | |
… | |
228 | aio_unlink $pathname, $callback->($status) |
227 | aio_unlink $pathname, $callback->($status) |
229 | aio_mknod $pathname, $mode, $dev, $callback->($status) |
228 | aio_mknod $pathname, $mode, $dev, $callback->($status) |
230 | aio_link $srcpath, $dstpath, $callback->($status) |
229 | aio_link $srcpath, $dstpath, $callback->($status) |
231 | aio_symlink $srcpath, $dstpath, $callback->($status) |
230 | aio_symlink $srcpath, $dstpath, $callback->($status) |
232 | aio_readlink $pathname, $callback->($link) |
231 | aio_readlink $pathname, $callback->($link) |
233 | aio_realpath $pathname, $callback->($link) |
232 | aio_realpath $pathname, $callback->($path) |
234 | aio_rename $srcpath, $dstpath, $callback->($status) |
233 | aio_rename $srcpath, $dstpath, $callback->($status) |
235 | aio_mkdir $pathname, $mode, $callback->($status) |
234 | aio_mkdir $pathname, $mode, $callback->($status) |
236 | aio_rmdir $pathname, $callback->($status) |
235 | aio_rmdir $pathname, $callback->($status) |
237 | aio_readdir $pathname, $callback->($entries) |
236 | aio_readdir $pathname, $callback->($entries) |
238 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
237 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
… | |
… | |
603 | namemax => 255, |
602 | namemax => 255, |
604 | frsize => 1024, |
603 | frsize => 1024, |
605 | fsid => 1810 |
604 | fsid => 1810 |
606 | } |
605 | } |
607 | |
606 | |
608 | Here is a (likely partial) list of fsid values used by Linux - it is safe |
607 | Here is a (likely partial - send me updates!) list of fsid values used by |
609 | to hardcode these when the $^O is C<linux>: |
608 | Linux - it is safe to hardcode these when C<$^O> is C<linux>: |
610 | |
609 | |
611 | 0x0000adf5 adfs |
610 | 0x0000adf5 adfs |
612 | 0x0000adff affs |
611 | 0x0000adff affs |
613 | 0x5346414f afs |
612 | 0x5346414f afs |
614 | 0x09041934 anon-inode filesystem |
613 | 0x09041934 anon-inode filesystem |
… | |
… | |
723 | Works like truncate(2) or ftruncate(2). |
722 | Works like truncate(2) or ftruncate(2). |
724 | |
723 | |
725 | |
724 | |
726 | =item aio_allocate $fh, $mode, $offset, $len, $callback->($status) |
725 | =item aio_allocate $fh, $mode, $offset, $len, $callback->($status) |
727 | |
726 | |
728 | Allocates or freed disk space according to the C<$mode> argument. See the |
727 | Allocates or frees disk space according to the C<$mode> argument. See the |
729 | linux C<fallocate> docuemntation for details. |
728 | linux C<fallocate> documentation for details. |
730 | |
729 | |
731 | C<$mode> can currently be C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> |
730 | C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate |
732 | to allocate space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE | |
731 | space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE | IO::AIO::FALLOC_FL_KEEP_SIZE>, |
733 | IO::AIO::FALLOC_FL_KEEP_SIZE>, to deallocate a file range. |
732 | to deallocate a file range. |
|
|
733 | |
|
|
734 | IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range |
|
|
735 | (without leaving a hole) and C<FALLOC_FL_ZERO_RANGE>, to zero a range (see |
|
|
736 | your L<fallocate(2)> manpage). |
734 | |
737 | |
735 | The file system block size used by C<fallocate> is presumably the |
738 | The file system block size used by C<fallocate> is presumably the |
736 | C<f_bsize> returned by C<statvfs>. |
739 | C<f_bsize> returned by C<statvfs>. |
737 | |
740 | |
738 | If C<fallocate> isn't available or cannot be emulated (currently no |
741 | If C<fallocate> isn't available or cannot be emulated (currently no |
… | |
… | |
783 | |
786 | |
784 | |
787 | |
785 | =item aio_realpath $pathname, $callback->($path) |
788 | =item aio_realpath $pathname, $callback->($path) |
786 | |
789 | |
787 | Asynchronously make the path absolute and resolve any symlinks in |
790 | Asynchronously make the path absolute and resolve any symlinks in |
788 | C<$path>. The resulting path only consists of directories (Same as |
791 | C<$path>. The resulting path only consists of directories (same as |
789 | L<Cwd::realpath>). |
792 | L<Cwd::realpath>). |
790 | |
793 | |
791 | This request can be used to get the absolute path of the current working |
794 | This request can be used to get the absolute path of the current working |
792 | directory by passing it a path of F<.> (a single dot). |
795 | directory by passing it a path of F<.> (a single dot). |
793 | |
796 | |
794 | |
797 | |
795 | =item aio_rename $srcpath, $dstpath, $callback->($status) |
798 | =item aio_rename $srcpath, $dstpath, $callback->($status) |
796 | |
799 | |
797 | Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as |
800 | Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as |
798 | rename(2) and call the callback with the result code. |
801 | rename(2) and call the callback with the result code. |
|
|
802 | |
|
|
803 | On systems that support the AIO::WD working directory abstraction |
|
|
804 | natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead |
|
|
805 | of failing, C<rename> is called on the absolute path of C<$wd>. |
799 | |
806 | |
800 | |
807 | |
801 | =item aio_mkdir $pathname, $mode, $callback->($status) |
808 | =item aio_mkdir $pathname, $mode, $callback->($status) |
802 | |
809 | |
803 | Asynchronously mkdir (create) a directory and call the callback with |
810 | Asynchronously mkdir (create) a directory and call the callback with |
… | |
… | |
807 | |
814 | |
808 | =item aio_rmdir $pathname, $callback->($status) |
815 | =item aio_rmdir $pathname, $callback->($status) |
809 | |
816 | |
810 | Asynchronously rmdir (delete) a directory and call the callback with the |
817 | Asynchronously rmdir (delete) a directory and call the callback with the |
811 | result code. |
818 | result code. |
|
|
819 | |
|
|
820 | On systems that support the AIO::WD working directory abstraction |
|
|
821 | natively, the case C<[$wd, "."]> is specialcased - instead of failing, |
|
|
822 | C<rmdir> is called on the absolute path of C<$wd>. |
812 | |
823 | |
813 | |
824 | |
814 | =item aio_readdir $pathname, $callback->($entries) |
825 | =item aio_readdir $pathname, $callback->($entries) |
815 | |
826 | |
816 | Unlike the POSIX call of the same name, C<aio_readdir> reads an entire |
827 | Unlike the POSIX call of the same name, C<aio_readdir> reads an entire |
… | |
… | |
1181 | } |
1192 | } |
1182 | |
1193 | |
1183 | =item aio_rmtree $pathname, $callback->($status) |
1194 | =item aio_rmtree $pathname, $callback->($status) |
1184 | |
1195 | |
1185 | Delete a directory tree starting (and including) C<$path>, return the |
1196 | Delete a directory tree starting (and including) C<$path>, return the |
1186 | status of the final C<rmdir> only. This is a composite request that |
1197 | status of the final C<rmdir> only. This is a composite request that |
1187 | uses C<aio_scandir> to recurse into and rmdir directories, and unlink |
1198 | uses C<aio_scandir> to recurse into and rmdir directories, and unlink |
1188 | everything else. |
1199 | everything else. |
1189 | |
1200 | |
1190 | =cut |
1201 | =cut |
1191 | |
1202 | |
… | |
… | |
1311 | |
1322 | |
1312 | This is a rather advanced IO::AIO call, which works best on mmap(2)ed |
1323 | This is a rather advanced IO::AIO call, which works best on mmap(2)ed |
1313 | scalars. |
1324 | scalars. |
1314 | |
1325 | |
1315 | It touches (reads or writes) all memory pages in the specified |
1326 | It touches (reads or writes) all memory pages in the specified |
1316 | range inside the scalar. All caveats and parameters are the same |
1327 | range inside the scalar. All caveats and parameters are the same |
1317 | as for C<aio_msync>, above, except for flags, which must be either |
1328 | as for C<aio_msync>, above, except for flags, which must be either |
1318 | C<0> (which reads all pages and ensures they are instantiated) or |
1329 | C<0> (which reads all pages and ensures they are instantiated) or |
1319 | C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and |
1330 | C<IO::AIO::MT_MODIFY>, which modifies the memory pages (by reading and |
1320 | writing an octet from it, which dirties the page). |
1331 | writing an octet from it, which dirties the page). |
1321 | |
1332 | |
1322 | =item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
1333 | =item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
1323 | |
1334 | |
1324 | This is a rather advanced IO::AIO call, which works best on mmap(2)ed |
1335 | This is a rather advanced IO::AIO call, which works best on mmap(2)ed |
… | |
… | |
1493 | aio_stat [$etcdir, "passwd"], sub { |
1504 | aio_stat [$etcdir, "passwd"], sub { |
1494 | # yay |
1505 | # yay |
1495 | }; |
1506 | }; |
1496 | }; |
1507 | }; |
1497 | |
1508 | |
1498 | That C<aio_wd> is a request and not a normal function shows that creating |
1509 | The fact that C<aio_wd> is a request and not a normal function shows that |
1499 | an IO::AIO::WD object is itself a potentially blocking operation, which is |
1510 | creating an IO::AIO::WD object is itself a potentially blocking operation, |
1500 | why it is done asynchronously. |
1511 | which is why it is done asynchronously. |
1501 | |
1512 | |
1502 | To stat the directory obtained with C<aio_wd> above, one could write |
1513 | To stat the directory obtained with C<aio_wd> above, one could write |
1503 | either of the following three request calls: |
1514 | either of the following three request calls: |
1504 | |
1515 | |
1505 | aio_lstat "/etc" , sub { ... # pathname as normal string |
1516 | aio_lstat "/etc" , sub { ... # pathname as normal string |
… | |
… | |
1525 | will still point to the original directory. Most functions accepting a |
1536 | will still point to the original directory. Most functions accepting a |
1526 | pathname will use the directory fd on newer systems, and the string on |
1537 | pathname will use the directory fd on newer systems, and the string on |
1527 | older systems. Some functions (such as realpath) will always rely on the |
1538 | older systems. Some functions (such as realpath) will always rely on the |
1528 | string form of the pathname. |
1539 | string form of the pathname. |
1529 | |
1540 | |
1530 | So this fucntionality is mainly useful to get some protection against |
1541 | So this functionality is mainly useful to get some protection against |
1531 | C<chdir>, to easily get an absolute path out of a relative path for future |
1542 | C<chdir>, to easily get an absolute path out of a relative path for future |
1532 | reference, and to speed up doing many operations in the same directory |
1543 | reference, and to speed up doing many operations in the same directory |
1533 | (e.g. when stat'ing all files in a directory). |
1544 | (e.g. when stat'ing all files in a directory). |
1534 | |
1545 | |
1535 | The following functions implement this working directory abstraction: |
1546 | The following functions implement this working directory abstraction: |
… | |
… | |
1548 | passing C<undef> as working directory component of a pathname fails the |
1559 | passing C<undef> as working directory component of a pathname fails the |
1549 | request with C<ENOENT>, there is often no need for error checking in the |
1560 | request with C<ENOENT>, there is often no need for error checking in the |
1550 | C<aio_wd> callback, as future requests using the value will fail in the |
1561 | C<aio_wd> callback, as future requests using the value will fail in the |
1551 | expected way. |
1562 | expected way. |
1552 | |
1563 | |
1553 | If this call isn't available because your OS lacks it or it couldn't be |
|
|
1554 | detected, it will be emulated by calling C<fsync> instead. |
|
|
1555 | |
|
|
1556 | =item IO::AIO::CWD |
1564 | =item IO::AIO::CWD |
1557 | |
1565 | |
1558 | This is a compiletime constant (object) that represents the process |
1566 | This is a compiletime constant (object) that represents the process |
1559 | current working directory. |
1567 | current working directory. |
1560 | |
1568 | |
1561 | Specifying this object as working directory object for a pathname is as |
1569 | Specifying this object as working directory object for a pathname is as if |
1562 | if the pathname would be specified directly, without a directory object, |
1570 | the pathname would be specified directly, without a directory object. For |
1563 | e.g., these calls are functionally identical: |
1571 | example, these calls are functionally identical: |
1564 | |
1572 | |
1565 | aio_stat "somefile", sub { ... }; |
1573 | aio_stat "somefile", sub { ... }; |
1566 | aio_stat [IO::AIO::CWD, "somefile"], sub { ... }; |
1574 | aio_stat [IO::AIO::CWD, "somefile"], sub { ... }; |
1567 | |
1575 | |
1568 | =back |
1576 | =back |
1569 | |
1577 | |
|
|
1578 | To recover the path associated with an IO::AIO::WD object, you can use |
|
|
1579 | C<aio_realpath>: |
|
|
1580 | |
|
|
1581 | aio_realpath $wd, sub { |
|
|
1582 | warn "path is $_[0]\n"; |
|
|
1583 | }; |
|
|
1584 | |
|
|
1585 | Currently, C<aio_statvfs> always, and C<aio_rename> and C<aio_rmdir> |
|
|
1586 | sometimes, fall back to using an absolue path. |
1570 | |
1587 | |
1571 | =head2 IO::AIO::REQ CLASS |
1588 | =head2 IO::AIO::REQ CLASS |
1572 | |
1589 | |
1573 | All non-aggregate C<aio_*> functions return an object of this class when |
1590 | All non-aggregate C<aio_*> functions return an object of this class when |
1574 | called in non-void context. |
1591 | called in non-void context. |
… | |
… | |
1752 | |
1769 | |
1753 | See C<poll_cb> for an example. |
1770 | See C<poll_cb> for an example. |
1754 | |
1771 | |
1755 | =item IO::AIO::poll_cb |
1772 | =item IO::AIO::poll_cb |
1756 | |
1773 | |
1757 | Process some outstanding events on the result pipe. You have to call |
1774 | Process some requests that have reached the result phase (i.e. they have |
|
|
1775 | been executed but the results are not yet reported). You have to call |
|
|
1776 | this "regularly" to finish outstanding requests. |
|
|
1777 | |
1758 | this regularly. Returns C<0> if all events could be processed (or there |
1778 | Returns C<0> if all events could be processed (or there were no |
1759 | were no events to process), or C<-1> if it returned earlier for whatever |
1779 | events to process), or C<-1> if it returned earlier for whatever |
1760 | reason. Returns immediately when no events are outstanding. The amount of |
1780 | reason. Returns immediately when no events are outstanding. The amount |
1761 | events processed depends on the settings of C<IO::AIO::max_poll_req> and |
1781 | of events processed depends on the settings of C<IO::AIO::max_poll_req>, |
1762 | C<IO::AIO::max_poll_time>. |
1782 | C<IO::AIO::max_poll_time> and C<IO::AIO::max_outstanding>. |
1763 | |
1783 | |
1764 | If not all requests were processed for whatever reason, the filehandle |
1784 | If not all requests were processed for whatever reason, the poll file |
1765 | will still be ready when C<poll_cb> returns, so normally you don't have to |
1785 | descriptor will still be ready when C<poll_cb> returns, so normally you |
1766 | do anything special to have it called later. |
1786 | don't have to do anything special to have it called later. |
1767 | |
1787 | |
1768 | Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes |
1788 | Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes |
1769 | ready, it can be beneficial to call this function from loops which submit |
1789 | ready, it can be beneficial to call this function from loops which submit |
1770 | a lot of requests, to make sure the results get processed when they become |
1790 | a lot of requests, to make sure the results get processed when they become |
1771 | available and not just when the loop is finished and the event loop takes |
1791 | available and not just when the loop is finished and the event loop takes |
… | |
… | |
1780 | poll => 'r', async => 1, |
1800 | poll => 'r', async => 1, |
1781 | cb => \&IO::AIO::poll_cb); |
1801 | cb => \&IO::AIO::poll_cb); |
1782 | |
1802 | |
1783 | =item IO::AIO::poll_wait |
1803 | =item IO::AIO::poll_wait |
1784 | |
1804 | |
1785 | If there are any outstanding requests and none of them in the result |
1805 | Wait until either at least one request is in the result phase or no |
1786 | phase, wait till the result filehandle becomes ready for reading (simply |
1806 | requests are outstanding anymore. |
1787 | does a C<select> on the filehandle. This is useful if you want to |
1807 | |
1788 | synchronously wait for some requests to finish). |
1808 | This is useful if you want to synchronously wait for some requests to |
|
|
1809 | become ready, without actually handling them. |
1789 | |
1810 | |
1790 | See C<nreqs> for an example. |
1811 | See C<nreqs> for an example. |
1791 | |
1812 | |
1792 | =item IO::AIO::poll |
1813 | =item IO::AIO::poll |
1793 | |
1814 | |
… | |
… | |
1914 | |
1935 | |
1915 | This is a very bad function to use in interactive programs because it |
1936 | This is a very bad function to use in interactive programs because it |
1916 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1937 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1917 | use an C<aio_group> together with a feed callback. |
1938 | use an C<aio_group> together with a feed callback. |
1918 | |
1939 | |
1919 | It's main use is in scripts without an event loop - when you want to stat |
1940 | Its main use is in scripts without an event loop - when you want to stat |
1920 | a lot of files, you can write somehting like this: |
1941 | a lot of files, you can write somehting like this: |
1921 | |
1942 | |
1922 | IO::AIO::max_outstanding 32; |
1943 | IO::AIO::max_outstanding 32; |
1923 | |
1944 | |
1924 | for my $path (...) { |
1945 | for my $path (...) { |
… | |
… | |
1964 | |
1985 | |
1965 | =back |
1986 | =back |
1966 | |
1987 | |
1967 | =head3 MISCELLANEOUS FUNCTIONS |
1988 | =head3 MISCELLANEOUS FUNCTIONS |
1968 | |
1989 | |
1969 | IO::AIO implements some functions that might be useful, but are not |
1990 | IO::AIO implements some functions that are useful when you want to use |
1970 | asynchronous. |
1991 | some "Advanced I/O" function not available to in Perl, without going the |
|
|
1992 | "Asynchronous I/O" route. Many of these have an asynchronous C<aio_*> |
|
|
1993 | counterpart. |
1971 | |
1994 | |
1972 | =over 4 |
1995 | =over 4 |
1973 | |
1996 | |
1974 | =item IO::AIO::sendfile $ofh, $ifh, $offset, $count |
1997 | =item IO::AIO::sendfile $ofh, $ifh, $offset, $count |
1975 | |
1998 | |
… | |
… | |
2093 | |
2116 | |
2094 | See the C<splice(2)> manpage for details. |
2117 | See the C<splice(2)> manpage for details. |
2095 | |
2118 | |
2096 | =item IO::AIO::tee $r_fh, $w_fh, $length, $flags |
2119 | =item IO::AIO::tee $r_fh, $w_fh, $length, $flags |
2097 | |
2120 | |
2098 | Calls the GNU/Linux C<tee(2)> syscall, see it's manpage and the |
2121 | Calls the GNU/Linux C<tee(2)> syscall, see its manpage and the |
2099 | description for C<IO::AIO::splice> above for details. |
2122 | description for C<IO::AIO::splice> above for details. |
|
|
2123 | |
|
|
2124 | =item $actual_size = IO::AIO::pipesize $r_fh[, $new_size] |
|
|
2125 | |
|
|
2126 | Attempts to query or change the pipe buffer size. Obviously works only |
|
|
2127 | on pipes, and currently works only on GNU/Linux systems, and fails with |
|
|
2128 | C<-1>/C<ENOSYS> everywhere else. If anybody knows how to influence pipe buffer |
|
|
2129 | size on other systems, drop me a note. |
|
|
2130 | |
|
|
2131 | =item ($rfh, $wfh) = IO::AIO::pipe2 [$flags] |
|
|
2132 | |
|
|
2133 | This is a direct interface to the Linux L<pipe2(2)> system call. If |
|
|
2134 | C<$flags> is missing or C<0>, then this should be the same as a call to |
|
|
2135 | perl's built-in C<pipe> function and create a new pipe, and works on |
|
|
2136 | systems that lack the pipe2 syscall. On win32, this case invokes C<_pipe |
|
|
2137 | (..., 4096, O_BINARY)>. |
|
|
2138 | |
|
|
2139 | If C<$flags> is non-zero, it tries to invoke the pipe2 system call with |
|
|
2140 | the given flags (Linux 2.6.27, glibc 2.9). |
|
|
2141 | |
|
|
2142 | On success, the read and write file handles are returned. |
|
|
2143 | |
|
|
2144 | On error, nothing will be returned. If the pipe2 syscall is missing and |
|
|
2145 | C<$flags> is non-zero, fails with C<ENOSYS>. |
|
|
2146 | |
|
|
2147 | Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the |
|
|
2148 | time of this writing, C<IO::AIO::O_CLOEXEC>, C<IO::AIO::O_NONBLOCK> and |
|
|
2149 | C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported. |
2100 | |
2150 | |
2101 | =back |
2151 | =back |
2102 | |
2152 | |
2103 | =cut |
2153 | =cut |
2104 | |
2154 | |