… | |
… | |
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.31; |
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> can currently be C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> |
732 | to allocate space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE | |
731 | to allocate space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE | |
733 | IO::AIO::FALLOC_FL_KEEP_SIZE>, to deallocate a file range. |
732 | IO::AIO::FALLOC_FL_KEEP_SIZE>, to deallocate a file range. |
734 | |
733 | |
… | |
… | |
795 | =item aio_rename $srcpath, $dstpath, $callback->($status) |
794 | =item aio_rename $srcpath, $dstpath, $callback->($status) |
796 | |
795 | |
797 | Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as |
796 | Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as |
798 | rename(2) and call the callback with the result code. |
797 | rename(2) and call the callback with the result code. |
799 | |
798 | |
|
|
799 | On systems that support the AIO::WD working directory abstraction |
|
|
800 | natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead |
|
|
801 | of failing, C<rename> is called on the absolute path of C<$wd>. |
|
|
802 | |
800 | |
803 | |
801 | =item aio_mkdir $pathname, $mode, $callback->($status) |
804 | =item aio_mkdir $pathname, $mode, $callback->($status) |
802 | |
805 | |
803 | Asynchronously mkdir (create) a directory and call the callback with |
806 | Asynchronously mkdir (create) a directory and call the callback with |
804 | the result code. C<$mode> will be modified by the umask at the time the |
807 | the result code. C<$mode> will be modified by the umask at the time the |
… | |
… | |
807 | |
810 | |
808 | =item aio_rmdir $pathname, $callback->($status) |
811 | =item aio_rmdir $pathname, $callback->($status) |
809 | |
812 | |
810 | Asynchronously rmdir (delete) a directory and call the callback with the |
813 | Asynchronously rmdir (delete) a directory and call the callback with the |
811 | result code. |
814 | result code. |
|
|
815 | |
|
|
816 | On systems that support the AIO::WD working directory abstraction |
|
|
817 | natively, the case C<[$wd, "."]> is specialcased - instead of failing, |
|
|
818 | C<rmdir> is called on the absolute path of C<$wd>. |
812 | |
819 | |
813 | |
820 | |
814 | =item aio_readdir $pathname, $callback->($entries) |
821 | =item aio_readdir $pathname, $callback->($entries) |
815 | |
822 | |
816 | Unlike the POSIX call of the same name, C<aio_readdir> reads an entire |
823 | Unlike the POSIX call of the same name, C<aio_readdir> reads an entire |
… | |
… | |
1493 | aio_stat [$etcdir, "passwd"], sub { |
1500 | aio_stat [$etcdir, "passwd"], sub { |
1494 | # yay |
1501 | # yay |
1495 | }; |
1502 | }; |
1496 | }; |
1503 | }; |
1497 | |
1504 | |
1498 | That C<aio_wd> is a request and not a normal function shows that creating |
1505 | 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 |
1506 | creating an IO::AIO::WD object is itself a potentially blocking operation, |
1500 | why it is done asynchronously. |
1507 | which is why it is done asynchronously. |
1501 | |
1508 | |
1502 | To stat the directory obtained with C<aio_wd> above, one could write |
1509 | To stat the directory obtained with C<aio_wd> above, one could write |
1503 | either of the following three request calls: |
1510 | either of the following three request calls: |
1504 | |
1511 | |
1505 | aio_lstat "/etc" , sub { ... # pathname as normal string |
1512 | aio_lstat "/etc" , sub { ... # pathname as normal string |
… | |
… | |
1548 | passing C<undef> as working directory component of a pathname fails the |
1555 | 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 |
1556 | 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 |
1557 | C<aio_wd> callback, as future requests using the value will fail in the |
1551 | expected way. |
1558 | expected way. |
1552 | |
1559 | |
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 |
1560 | =item IO::AIO::CWD |
1557 | |
1561 | |
1558 | This is a compiletime constant (object) that represents the process |
1562 | This is a compiletime constant (object) that represents the process |
1559 | current working directory. |
1563 | current working directory. |
1560 | |
1564 | |
… | |
… | |
1572 | |
1576 | |
1573 | aio_realpath $wd, sub { |
1577 | aio_realpath $wd, sub { |
1574 | warn "path is $_[0]\n"; |
1578 | warn "path is $_[0]\n"; |
1575 | }; |
1579 | }; |
1576 | |
1580 | |
|
|
1581 | Currently, C<aio_statvfs> always, and C<aio_rename> and C<aio_rmdir> |
|
|
1582 | sometimes, fall back to using an absolue path. |
1577 | |
1583 | |
1578 | =head2 IO::AIO::REQ CLASS |
1584 | =head2 IO::AIO::REQ CLASS |
1579 | |
1585 | |
1580 | All non-aggregate C<aio_*> functions return an object of this class when |
1586 | All non-aggregate C<aio_*> functions return an object of this class when |
1581 | called in non-void context. |
1587 | called in non-void context. |
… | |
… | |
1925 | |
1931 | |
1926 | This is a very bad function to use in interactive programs because it |
1932 | This is a very bad function to use in interactive programs because it |
1927 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1933 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1928 | use an C<aio_group> together with a feed callback. |
1934 | use an C<aio_group> together with a feed callback. |
1929 | |
1935 | |
1930 | It's main use is in scripts without an event loop - when you want to stat |
1936 | Its main use is in scripts without an event loop - when you want to stat |
1931 | a lot of files, you can write somehting like this: |
1937 | a lot of files, you can write somehting like this: |
1932 | |
1938 | |
1933 | IO::AIO::max_outstanding 32; |
1939 | IO::AIO::max_outstanding 32; |
1934 | |
1940 | |
1935 | for my $path (...) { |
1941 | for my $path (...) { |
… | |
… | |
1975 | |
1981 | |
1976 | =back |
1982 | =back |
1977 | |
1983 | |
1978 | =head3 MISCELLANEOUS FUNCTIONS |
1984 | =head3 MISCELLANEOUS FUNCTIONS |
1979 | |
1985 | |
1980 | IO::AIO implements some functions that might be useful, but are not |
1986 | IO::AIO implements some functions that are useful when you want to use |
1981 | asynchronous. |
1987 | some "Advanced I/O" function not available to in Perl, without going the |
|
|
1988 | "Asynchronous I/O" route. Many of these have an asynchronous C<aio_*> |
|
|
1989 | counterpart. |
1982 | |
1990 | |
1983 | =over 4 |
1991 | =over 4 |
1984 | |
1992 | |
1985 | =item IO::AIO::sendfile $ofh, $ifh, $offset, $count |
1993 | =item IO::AIO::sendfile $ofh, $ifh, $offset, $count |
1986 | |
1994 | |
… | |
… | |
2104 | |
2112 | |
2105 | See the C<splice(2)> manpage for details. |
2113 | See the C<splice(2)> manpage for details. |
2106 | |
2114 | |
2107 | =item IO::AIO::tee $r_fh, $w_fh, $length, $flags |
2115 | =item IO::AIO::tee $r_fh, $w_fh, $length, $flags |
2108 | |
2116 | |
2109 | Calls the GNU/Linux C<tee(2)> syscall, see it's manpage and the |
2117 | Calls the GNU/Linux C<tee(2)> syscall, see its manpage and the |
2110 | description for C<IO::AIO::splice> above for details. |
2118 | description for C<IO::AIO::splice> above for details. |
|
|
2119 | |
|
|
2120 | =item $actual_size = IO::AIO::pipesize $r_fh[, $new_size] |
|
|
2121 | |
|
|
2122 | Attempts to query or change the pipe buffer size. Obviously works only |
|
|
2123 | on pipes, and currently works only on GNU/Linux systems, and fails with |
|
|
2124 | C<-1>/C<ENOSYS> everywhere else. If anybody knows how to influence pipe buffer |
|
|
2125 | size on other systems, drop me a note. |
2111 | |
2126 | |
2112 | =back |
2127 | =back |
2113 | |
2128 | |
2114 | =cut |
2129 | =cut |
2115 | |
2130 | |