| … | |
… | |
| 64 | |
64 | |
| 65 | EXAMPLE |
65 | EXAMPLE |
| 66 | This is a simple example that uses the EV module and loads /etc/passwd |
66 | This is a simple example that uses the EV module and loads /etc/passwd |
| 67 | asynchronously: |
67 | asynchronously: |
| 68 | |
68 | |
| 69 | use Fcntl; |
|
|
| 70 | use EV; |
69 | use EV; |
| 71 | use IO::AIO; |
70 | use IO::AIO; |
| 72 | |
71 | |
| 73 | # register the IO::AIO callback with EV |
72 | # register the IO::AIO callback with EV |
| 74 | my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; |
73 | my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; |
| … | |
… | |
| 91 | |
90 | |
| 92 | # file contents now in $contents |
91 | # file contents now in $contents |
| 93 | print $contents; |
92 | print $contents; |
| 94 | |
93 | |
| 95 | # exit event loop and program |
94 | # exit event loop and program |
| 96 | EV::unloop; |
95 | EV::break; |
| 97 | }; |
96 | }; |
| 98 | }; |
97 | }; |
| 99 | |
98 | |
| 100 | # possibly queue up other requests, or open GUI windows, |
99 | # possibly queue up other requests, or open GUI windows, |
| 101 | # check for sockets etc. etc. |
100 | # check for sockets etc. etc. |
| 102 | |
101 | |
| 103 | # process events as long as there are some: |
102 | # process events as long as there are some: |
| 104 | EV::loop; |
103 | EV::run; |
| 105 | |
104 | |
| 106 | REQUEST ANATOMY AND LIFETIME |
105 | REQUEST ANATOMY AND LIFETIME |
| 107 | Every "aio_*" function creates a request. which is a C data structure |
106 | Every "aio_*" function creates a request. which is a C data structure |
| 108 | not directly visible to Perl. |
107 | not directly visible to Perl. |
| 109 | |
108 | |
| … | |
… | |
| 172 | aio_unlink $pathname, $callback->($status) |
171 | aio_unlink $pathname, $callback->($status) |
| 173 | aio_mknod $pathname, $mode, $dev, $callback->($status) |
172 | aio_mknod $pathname, $mode, $dev, $callback->($status) |
| 174 | aio_link $srcpath, $dstpath, $callback->($status) |
173 | aio_link $srcpath, $dstpath, $callback->($status) |
| 175 | aio_symlink $srcpath, $dstpath, $callback->($status) |
174 | aio_symlink $srcpath, $dstpath, $callback->($status) |
| 176 | aio_readlink $pathname, $callback->($link) |
175 | aio_readlink $pathname, $callback->($link) |
| 177 | aio_realpath $pathname, $callback->($link) |
176 | aio_realpath $pathname, $callback->($path) |
| 178 | aio_rename $srcpath, $dstpath, $callback->($status) |
177 | aio_rename $srcpath, $dstpath, $callback->($status) |
| 179 | aio_mkdir $pathname, $mode, $callback->($status) |
178 | aio_mkdir $pathname, $mode, $callback->($status) |
| 180 | aio_rmdir $pathname, $callback->($status) |
179 | aio_rmdir $pathname, $callback->($status) |
| 181 | aio_readdir $pathname, $callback->($entries) |
180 | aio_readdir $pathname, $callback->($entries) |
| 182 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
181 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
| … | |
… | |
| 185 | aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs) |
184 | aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs) |
| 186 | aio_load $pathname, $data, $callback->($status) |
185 | aio_load $pathname, $data, $callback->($status) |
| 187 | aio_copy $srcpath, $dstpath, $callback->($status) |
186 | aio_copy $srcpath, $dstpath, $callback->($status) |
| 188 | aio_move $srcpath, $dstpath, $callback->($status) |
187 | aio_move $srcpath, $dstpath, $callback->($status) |
| 189 | aio_rmtree $pathname, $callback->($status) |
188 | aio_rmtree $pathname, $callback->($status) |
|
|
189 | aio_fcntl $fh, $cmd, $arg, $callback->($status) |
|
|
190 | aio_ioctl $fh, $request, $buf, $callback->($status) |
| 190 | aio_sync $callback->($status) |
191 | aio_sync $callback->($status) |
| 191 | aio_syncfs $fh, $callback->($status) |
192 | aio_syncfs $fh, $callback->($status) |
| 192 | aio_fsync $fh, $callback->($status) |
193 | aio_fsync $fh, $callback->($status) |
| 193 | aio_fdatasync $fh, $callback->($status) |
194 | aio_fdatasync $fh, $callback->($status) |
| 194 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
195 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
| … | |
… | |
| 331 | "O_APPEND"), the following POSIX and non-POSIX constants are |
332 | "O_APPEND"), the following POSIX and non-POSIX constants are |
| 332 | available (missing ones on your system are, as usual, 0): |
333 | available (missing ones on your system are, as usual, 0): |
| 333 | |
334 | |
| 334 | "O_ASYNC", "O_DIRECT", "O_NOATIME", "O_CLOEXEC", "O_NOCTTY", |
335 | "O_ASYNC", "O_DIRECT", "O_NOATIME", "O_CLOEXEC", "O_NOCTTY", |
| 335 | "O_NOFOLLOW", "O_NONBLOCK", "O_EXEC", "O_SEARCH", "O_DIRECTORY", |
336 | "O_NOFOLLOW", "O_NONBLOCK", "O_EXEC", "O_SEARCH", "O_DIRECTORY", |
| 336 | "O_DSYNC", "O_RSYNC", "O_SYNC" and "O_TTY_INIT". |
337 | "O_DSYNC", "O_RSYNC", "O_SYNC", "O_PATH", "O_TMPFILE", and |
|
|
338 | "O_TTY_INIT". |
| 337 | |
339 | |
| 338 | aio_close $fh, $callback->($status) |
340 | aio_close $fh, $callback->($status) |
| 339 | Asynchronously close a file and call the callback with the result |
341 | Asynchronously close a file and call the callback with the result |
| 340 | code. |
342 | code. |
| 341 | |
343 | |
| … | |
… | |
| 530 | namemax => 255, |
532 | namemax => 255, |
| 531 | frsize => 1024, |
533 | frsize => 1024, |
| 532 | fsid => 1810 |
534 | fsid => 1810 |
| 533 | } |
535 | } |
| 534 | |
536 | |
| 535 | Here is a (likely partial) list of fsid values used by Linux - it is |
537 | Here is a (likely partial - send me updates!) list of fsid values |
| 536 | safe to hardcode these when the $^O is "linux": |
538 | used by Linux - it is safe to hardcode these when $^O is "linux": |
| 537 | |
539 | |
| 538 | 0x0000adf5 adfs |
540 | 0x0000adf5 adfs |
| 539 | 0x0000adff affs |
541 | 0x0000adff affs |
| 540 | 0x5346414f afs |
542 | 0x5346414f afs |
| 541 | 0x09041934 anon-inode filesystem |
543 | 0x09041934 anon-inode filesystem |
| … | |
… | |
| 554 | 0x00001373 devfs |
556 | 0x00001373 devfs |
| 555 | 0x00001cd1 devpts |
557 | 0x00001cd1 devpts |
| 556 | 0x0000f15f ecryptfs |
558 | 0x0000f15f ecryptfs |
| 557 | 0x00414a53 efs |
559 | 0x00414a53 efs |
| 558 | 0x0000137d ext |
560 | 0x0000137d ext |
| 559 | 0x0000ef53 ext2/ext3 |
561 | 0x0000ef53 ext2/ext3/ext4 |
| 560 | 0x0000ef51 ext2 |
562 | 0x0000ef51 ext2 |
|
|
563 | 0xf2f52010 f2fs |
| 561 | 0x00004006 fat |
564 | 0x00004006 fat |
| 562 | 0x65735546 fuseblk |
565 | 0x65735546 fuseblk |
| 563 | 0x65735543 fusectl |
566 | 0x65735543 fusectl |
| 564 | 0x0bad1dea futexfs |
567 | 0x0bad1dea futexfs |
| 565 | 0x01161970 gfs2 |
568 | 0x01161970 gfs2 |
| 566 | 0x47504653 gpfs |
569 | 0x47504653 gpfs |
| 567 | 0x00004244 hfs |
570 | 0x00004244 hfs |
| 568 | 0xf995e849 hpfs |
571 | 0xf995e849 hpfs |
|
|
572 | 0x00c0ffee hostfs |
| 569 | 0x958458f6 hugetlbfs |
573 | 0x958458f6 hugetlbfs |
| 570 | 0x2bad1dea inotifyfs |
574 | 0x2bad1dea inotifyfs |
| 571 | 0x00009660 isofs |
575 | 0x00009660 isofs |
| 572 | 0x000072b6 jffs2 |
576 | 0x000072b6 jffs2 |
| 573 | 0x3153464a jfs |
577 | 0x3153464a jfs |
| … | |
… | |
| 588 | 0x00009fa1 openprom |
592 | 0x00009fa1 openprom |
| 589 | 0x7461636F ocfs2 |
593 | 0x7461636F ocfs2 |
| 590 | 0x00009fa0 proc |
594 | 0x00009fa0 proc |
| 591 | 0x6165676c pstorefs |
595 | 0x6165676c pstorefs |
| 592 | 0x0000002f qnx4 |
596 | 0x0000002f qnx4 |
|
|
597 | 0x68191122 qnx6 |
| 593 | 0x858458f6 ramfs |
598 | 0x858458f6 ramfs |
| 594 | 0x52654973 reiserfs |
599 | 0x52654973 reiserfs |
| 595 | 0x00007275 romfs |
600 | 0x00007275 romfs |
| 596 | 0x67596969 rpc_pipefs |
601 | 0x67596969 rpc_pipefs |
| 597 | 0x73636673 securityfs |
602 | 0x73636673 securityfs |
| … | |
… | |
| 644 | |
649 | |
| 645 | aio_truncate $fh_or_path, $offset, $callback->($status) |
650 | aio_truncate $fh_or_path, $offset, $callback->($status) |
| 646 | Works like truncate(2) or ftruncate(2). |
651 | Works like truncate(2) or ftruncate(2). |
| 647 | |
652 | |
| 648 | aio_allocate $fh, $mode, $offset, $len, $callback->($status) |
653 | aio_allocate $fh, $mode, $offset, $len, $callback->($status) |
| 649 | Allocates or freed disk space according to the $mode argument. See |
654 | Allocates or frees disk space according to the $mode argument. See |
| 650 | the linux "fallocate" docuemntation for details. |
655 | the linux "fallocate" documentation for details. |
| 651 | |
656 | |
| 652 | $mode can currently be 0 or "IO::AIO::FALLOC_FL_KEEP_SIZE" to |
657 | $mode is usually 0 or "IO::AIO::FALLOC_FL_KEEP_SIZE" to allocate |
| 653 | allocate space, or "IO::AIO::FALLOC_FL_PUNCH_HOLE | |
658 | space, or "IO::AIO::FALLOC_FL_PUNCH_HOLE | |
| 654 | IO::AIO::FALLOC_FL_KEEP_SIZE", to deallocate a file range. |
659 | IO::AIO::FALLOC_FL_KEEP_SIZE", to deallocate a file range. |
|
|
660 | |
|
|
661 | IO::AIO also supports "FALLOC_FL_COLLAPSE_RANGE", to remove a range |
|
|
662 | (without leaving a hole) and "FALLOC_FL_ZERO_RANGE", to zero a range |
|
|
663 | (see your fallocate(2) manpage). |
| 655 | |
664 | |
| 656 | The file system block size used by "fallocate" is presumably the |
665 | The file system block size used by "fallocate" is presumably the |
| 657 | "f_bsize" returned by "statvfs". |
666 | "f_bsize" returned by "statvfs". |
| 658 | |
667 | |
| 659 | If "fallocate" isn't available or cannot be emulated (currently no |
668 | If "fallocate" isn't available or cannot be emulated (currently no |
| … | |
… | |
| 692 | the callback. If an error occurs, nothing or undef gets passed to |
701 | the callback. If an error occurs, nothing or undef gets passed to |
| 693 | the callback. |
702 | the callback. |
| 694 | |
703 | |
| 695 | aio_realpath $pathname, $callback->($path) |
704 | aio_realpath $pathname, $callback->($path) |
| 696 | Asynchronously make the path absolute and resolve any symlinks in |
705 | Asynchronously make the path absolute and resolve any symlinks in |
| 697 | $path. The resulting path only consists of directories (Same as |
706 | $path. The resulting path only consists of directories (same as |
| 698 | Cwd::realpath). |
707 | Cwd::realpath). |
| 699 | |
708 | |
| 700 | This request can be used to get the absolute path of the current |
709 | This request can be used to get the absolute path of the current |
| 701 | working directory by passing it a path of . (a single dot). |
710 | working directory by passing it a path of . (a single dot). |
| 702 | |
711 | |
| 703 | aio_rename $srcpath, $dstpath, $callback->($status) |
712 | aio_rename $srcpath, $dstpath, $callback->($status) |
| 704 | Asynchronously rename the object at $srcpath to $dstpath, just as |
713 | Asynchronously rename the object at $srcpath to $dstpath, just as |
| 705 | rename(2) and call the callback with the result code. |
714 | rename(2) and call the callback with the result code. |
|
|
715 | |
|
|
716 | On systems that support the AIO::WD working directory abstraction |
|
|
717 | natively, the case "[$wd, "."]" as $srcpath is specialcased - |
|
|
718 | instead of failing, "rename" is called on the absolute path of $wd. |
| 706 | |
719 | |
| 707 | aio_mkdir $pathname, $mode, $callback->($status) |
720 | aio_mkdir $pathname, $mode, $callback->($status) |
| 708 | Asynchronously mkdir (create) a directory and call the callback with |
721 | Asynchronously mkdir (create) a directory and call the callback with |
| 709 | the result code. $mode will be modified by the umask at the time the |
722 | the result code. $mode will be modified by the umask at the time the |
| 710 | request is executed, so do not change your umask. |
723 | request is executed, so do not change your umask. |
| 711 | |
724 | |
| 712 | aio_rmdir $pathname, $callback->($status) |
725 | aio_rmdir $pathname, $callback->($status) |
| 713 | Asynchronously rmdir (delete) a directory and call the callback with |
726 | Asynchronously rmdir (delete) a directory and call the callback with |
| 714 | the result code. |
727 | the result code. |
|
|
728 | |
|
|
729 | On systems that support the AIO::WD working directory abstraction |
|
|
730 | natively, the case "[$wd, "."]" is specialcased - instead of |
|
|
731 | failing, "rmdir" is called on the absolute path of $wd. |
| 715 | |
732 | |
| 716 | aio_readdir $pathname, $callback->($entries) |
733 | aio_readdir $pathname, $callback->($entries) |
| 717 | Unlike the POSIX call of the same name, "aio_readdir" reads an |
734 | Unlike the POSIX call of the same name, "aio_readdir" reads an |
| 718 | entire directory (i.e. opendir + readdir + closedir). The entries |
735 | entire directory (i.e. opendir + readdir + closedir). The entries |
| 719 | will not be sorted, and will NOT include the "." and ".." entries. |
736 | will not be sorted, and will NOT include the "." and ".." entries. |
| … | |
… | |
| 873 | Delete a directory tree starting (and including) $path, return the |
890 | Delete a directory tree starting (and including) $path, return the |
| 874 | status of the final "rmdir" only. This is a composite request that |
891 | status of the final "rmdir" only. This is a composite request that |
| 875 | uses "aio_scandir" to recurse into and rmdir directories, and unlink |
892 | uses "aio_scandir" to recurse into and rmdir directories, and unlink |
| 876 | everything else. |
893 | everything else. |
| 877 | |
894 | |
|
|
895 | aio_fcntl $fh, $cmd, $arg, $callback->($status) |
|
|
896 | aio_ioctl $fh, $request, $buf, $callback->($status) |
|
|
897 | These work just like the "fcntl" and "ioctl" built-in functions, |
|
|
898 | except they execute asynchronously and pass the return value to the |
|
|
899 | callback. |
|
|
900 | |
|
|
901 | Both calls can be used for a lot of things, some of which make more |
|
|
902 | sense to run asynchronously in their own thread, while some others |
|
|
903 | make less sense. For example, calls that block waiting for external |
|
|
904 | events, such as locking, will also lock down an I/O thread while it |
|
|
905 | is waiting, which can deadlock the whole I/O system. At the same |
|
|
906 | time, there might be no alternative to using a thread to wait. |
|
|
907 | |
|
|
908 | So in general, you should only use these calls for things that do |
|
|
909 | (filesystem) I/O, not for things that wait for other events |
|
|
910 | (network, other processes), although if you are careful and know |
|
|
911 | what you are doing, you still can. |
|
|
912 | |
| 878 | aio_sync $callback->($status) |
913 | aio_sync $callback->($status) |
| 879 | Asynchronously call sync and call the callback when finished. |
914 | Asynchronously call sync and call the callback when finished. |
| 880 | |
915 | |
| 881 | aio_fsync $fh, $callback->($status) |
916 | aio_fsync $fh, $callback->($status) |
| 882 | Asynchronously call fsync on the given filehandle and call the |
917 | Asynchronously call fsync on the given filehandle and call the |
| … | |
… | |
| 942 | |
977 | |
| 943 | It touches (reads or writes) all memory pages in the specified range |
978 | It touches (reads or writes) all memory pages in the specified range |
| 944 | inside the scalar. All caveats and parameters are the same as for |
979 | inside the scalar. All caveats and parameters are the same as for |
| 945 | "aio_msync", above, except for flags, which must be either 0 (which |
980 | "aio_msync", above, except for flags, which must be either 0 (which |
| 946 | reads all pages and ensures they are instantiated) or |
981 | reads all pages and ensures they are instantiated) or |
| 947 | "IO::AIO::MT_MODIFY", which modifies the memory page s(by reading |
982 | "IO::AIO::MT_MODIFY", which modifies the memory pages (by reading |
| 948 | and writing an octet from it, which dirties the page). |
983 | and writing an octet from it, which dirties the page). |
| 949 | |
984 | |
| 950 | aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
985 | aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
| 951 | This is a rather advanced IO::AIO call, which works best on |
986 | This is a rather advanced IO::AIO call, which works best on |
| 952 | mmap(2)ed scalars. |
987 | mmap(2)ed scalars. |
| … | |
… | |
| 1121 | aio_stat [$etcdir, "passwd"], sub { |
1156 | aio_stat [$etcdir, "passwd"], sub { |
| 1122 | # yay |
1157 | # yay |
| 1123 | }; |
1158 | }; |
| 1124 | }; |
1159 | }; |
| 1125 | |
1160 | |
| 1126 | That "aio_wd" is a request and not a normal function shows that creating |
1161 | The fact that "aio_wd" is a request and not a normal function shows that |
| 1127 | an IO::AIO::WD object is itself a potentially blocking operation, which |
1162 | creating an IO::AIO::WD object is itself a potentially blocking |
| 1128 | is why it is done asynchronously. |
1163 | operation, which is why it is done asynchronously. |
| 1129 | |
1164 | |
| 1130 | To stat the directory obtained with "aio_wd" above, one could write |
1165 | To stat the directory obtained with "aio_wd" above, one could write |
| 1131 | either of the following three request calls: |
1166 | either of the following three request calls: |
| 1132 | |
1167 | |
| 1133 | aio_lstat "/etc" , sub { ... # pathname as normal string |
1168 | aio_lstat "/etc" , sub { ... # pathname as normal string |
| … | |
… | |
| 1153 | will still point to the original directory. Most functions accepting a |
1188 | will still point to the original directory. Most functions accepting a |
| 1154 | pathname will use the directory fd on newer systems, and the string on |
1189 | pathname will use the directory fd on newer systems, and the string on |
| 1155 | older systems. Some functions (such as realpath) will always rely on the |
1190 | older systems. Some functions (such as realpath) will always rely on the |
| 1156 | string form of the pathname. |
1191 | string form of the pathname. |
| 1157 | |
1192 | |
| 1158 | So this fucntionality is mainly useful to get some protection against |
1193 | So this functionality is mainly useful to get some protection against |
| 1159 | "chdir", to easily get an absolute path out of a relative path for |
1194 | "chdir", to easily get an absolute path out of a relative path for |
| 1160 | future reference, and to speed up doing many operations in the same |
1195 | future reference, and to speed up doing many operations in the same |
| 1161 | directory (e.g. when stat'ing all files in a directory). |
1196 | directory (e.g. when stat'ing all files in a directory). |
| 1162 | |
1197 | |
| 1163 | The following functions implement this working directory abstraction: |
1198 | The following functions implement this working directory abstraction: |
| … | |
… | |
| 1173 | Since passing "undef" as working directory component of a pathname |
1208 | Since passing "undef" as working directory component of a pathname |
| 1174 | fails the request with "ENOENT", there is often no need for error |
1209 | fails the request with "ENOENT", there is often no need for error |
| 1175 | checking in the "aio_wd" callback, as future requests using the |
1210 | checking in the "aio_wd" callback, as future requests using the |
| 1176 | value will fail in the expected way. |
1211 | value will fail in the expected way. |
| 1177 | |
1212 | |
| 1178 | If this call isn't available because your OS lacks it or it couldn't |
|
|
| 1179 | be detected, it will be emulated by calling "fsync" instead. |
|
|
| 1180 | |
|
|
| 1181 | IO::AIO::CWD |
1213 | IO::AIO::CWD |
| 1182 | This is a compiletime constant (object) that represents the process |
1214 | This is a compiletime constant (object) that represents the process |
| 1183 | current working directory. |
1215 | current working directory. |
| 1184 | |
1216 | |
| 1185 | Specifying this object as working directory object for a pathname is |
1217 | Specifying this object as working directory object for a pathname is |
| 1186 | as if the pathname would be specified directly, without a directory |
1218 | as if the pathname would be specified directly, without a directory |
| 1187 | object, e.g., these calls are functionally identical: |
1219 | object. For example, these calls are functionally identical: |
| 1188 | |
1220 | |
| 1189 | aio_stat "somefile", sub { ... }; |
1221 | aio_stat "somefile", sub { ... }; |
| 1190 | aio_stat [IO::AIO::CWD, "somefile"], sub { ... }; |
1222 | aio_stat [IO::AIO::CWD, "somefile"], sub { ... }; |
|
|
1223 | |
|
|
1224 | To recover the path associated with an IO::AIO::WD object, you can use |
|
|
1225 | "aio_realpath": |
|
|
1226 | |
|
|
1227 | aio_realpath $wd, sub { |
|
|
1228 | warn "path is $_[0]\n"; |
|
|
1229 | }; |
|
|
1230 | |
|
|
1231 | Currently, "aio_statvfs" always, and "aio_rename" and "aio_rmdir" |
|
|
1232 | sometimes, fall back to using an absolue path. |
| 1191 | |
1233 | |
| 1192 | IO::AIO::REQ CLASS |
1234 | IO::AIO::REQ CLASS |
| 1193 | All non-aggregate "aio_*" functions return an object of this class when |
1235 | All non-aggregate "aio_*" functions return an object of this class when |
| 1194 | called in non-void context. |
1236 | called in non-void context. |
| 1195 | |
1237 | |
| … | |
… | |
| 1347 | results. |
1389 | results. |
| 1348 | |
1390 | |
| 1349 | See "poll_cb" for an example. |
1391 | See "poll_cb" for an example. |
| 1350 | |
1392 | |
| 1351 | IO::AIO::poll_cb |
1393 | IO::AIO::poll_cb |
| 1352 | Process some outstanding events on the result pipe. You have to call |
1394 | Process some requests that have reached the result phase (i.e. they |
|
|
1395 | have been executed but the results are not yet reported). You have |
|
|
1396 | to call this "regularly" to finish outstanding requests. |
|
|
1397 | |
| 1353 | this regularly. Returns 0 if all events could be processed (or there |
1398 | Returns 0 if all events could be processed (or there were no events |
| 1354 | were no events to process), or -1 if it returned earlier for |
1399 | to process), or -1 if it returned earlier for whatever reason. |
| 1355 | whatever reason. Returns immediately when no events are outstanding. |
1400 | Returns immediately when no events are outstanding. The amount of |
| 1356 | The amount of events processed depends on the settings of |
1401 | events processed depends on the settings of "IO::AIO::max_poll_req", |
| 1357 | "IO::AIO::max_poll_req" and "IO::AIO::max_poll_time". |
1402 | "IO::AIO::max_poll_time" and "IO::AIO::max_outstanding". |
| 1358 | |
1403 | |
| 1359 | If not all requests were processed for whatever reason, the |
1404 | If not all requests were processed for whatever reason, the poll |
| 1360 | filehandle will still be ready when "poll_cb" returns, so normally |
1405 | file descriptor will still be ready when "poll_cb" returns, so |
| 1361 | you don't have to do anything special to have it called later. |
1406 | normally you don't have to do anything special to have it called |
|
|
1407 | later. |
| 1362 | |
1408 | |
| 1363 | Apart from calling "IO::AIO::poll_cb" when the event filehandle |
1409 | Apart from calling "IO::AIO::poll_cb" when the event filehandle |
| 1364 | becomes ready, it can be beneficial to call this function from loops |
1410 | becomes ready, it can be beneficial to call this function from loops |
| 1365 | which submit a lot of requests, to make sure the results get |
1411 | which submit a lot of requests, to make sure the results get |
| 1366 | processed when they become available and not just when the loop is |
1412 | processed when they become available and not just when the loop is |
| … | |
… | |
| 1374 | Event->io (fd => IO::AIO::poll_fileno, |
1420 | Event->io (fd => IO::AIO::poll_fileno, |
| 1375 | poll => 'r', async => 1, |
1421 | poll => 'r', async => 1, |
| 1376 | cb => \&IO::AIO::poll_cb); |
1422 | cb => \&IO::AIO::poll_cb); |
| 1377 | |
1423 | |
| 1378 | IO::AIO::poll_wait |
1424 | IO::AIO::poll_wait |
| 1379 | If there are any outstanding requests and none of them in the result |
1425 | Wait until either at least one request is in the result phase or no |
| 1380 | phase, wait till the result filehandle becomes ready for reading |
1426 | requests are outstanding anymore. |
| 1381 | (simply does a "select" on the filehandle. This is useful if you |
1427 | |
| 1382 | want to synchronously wait for some requests to finish). |
1428 | This is useful if you want to synchronously wait for some requests |
|
|
1429 | to become ready, without actually handling them. |
| 1383 | |
1430 | |
| 1384 | See "nreqs" for an example. |
1431 | See "nreqs" for an example. |
| 1385 | |
1432 | |
| 1386 | IO::AIO::poll |
1433 | IO::AIO::poll |
| 1387 | Waits until some requests have been handled. |
1434 | Waits until some requests have been handled. |
| … | |
… | |
| 1499 | |
1546 | |
| 1500 | This is a very bad function to use in interactive programs because |
1547 | This is a very bad function to use in interactive programs because |
| 1501 | it blocks, and a bad way to reduce concurrency because it is |
1548 | it blocks, and a bad way to reduce concurrency because it is |
| 1502 | inexact: Better use an "aio_group" together with a feed callback. |
1549 | inexact: Better use an "aio_group" together with a feed callback. |
| 1503 | |
1550 | |
| 1504 | It's main use is in scripts without an event loop - when you want to |
1551 | Its main use is in scripts without an event loop - when you want to |
| 1505 | stat a lot of files, you can write somehting like this: |
1552 | stat a lot of files, you can write somehting like this: |
| 1506 | |
1553 | |
| 1507 | IO::AIO::max_outstanding 32; |
1554 | IO::AIO::max_outstanding 32; |
| 1508 | |
1555 | |
| 1509 | for my $path (...) { |
1556 | for my $path (...) { |
| … | |
… | |
| 1540 | IO::AIO::npending |
1587 | IO::AIO::npending |
| 1541 | Returns the number of requests currently in the pending state |
1588 | Returns the number of requests currently in the pending state |
| 1542 | (executed, but not yet processed by poll_cb). |
1589 | (executed, but not yet processed by poll_cb). |
| 1543 | |
1590 | |
| 1544 | MISCELLANEOUS FUNCTIONS |
1591 | MISCELLANEOUS FUNCTIONS |
| 1545 | IO::AIO implements some functions that might be useful, but are not |
1592 | IO::AIO implements some functions that are useful when you want to use |
| 1546 | asynchronous. |
1593 | some "Advanced I/O" function not available to in Perl, without going the |
|
|
1594 | "Asynchronous I/O" route. Many of these have an asynchronous "aio_*" |
|
|
1595 | counterpart. |
| 1547 | |
1596 | |
| 1548 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
1597 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
| 1549 | Calls the "eio_sendfile_sync" function, which is like |
1598 | Calls the "eio_sendfile_sync" function, which is like |
| 1550 | "aio_sendfile", but is blocking (this makes most sense if you know |
1599 | "aio_sendfile", but is blocking (this makes most sense if you know |
| 1551 | the input data is likely cached already and the output filehandle is |
1600 | the input data is likely cached already and the output filehandle is |
| … | |
… | |
| 1607 | "IO::AIO::PROT_EXEC", "IO::AIO::PROT_READ" and/or |
1656 | "IO::AIO::PROT_EXEC", "IO::AIO::PROT_READ" and/or |
| 1608 | "IO::AIO::PROT_WRITE", |
1657 | "IO::AIO::PROT_WRITE", |
| 1609 | |
1658 | |
| 1610 | $flags can be a combination of "IO::AIO::MAP_SHARED" or |
1659 | $flags can be a combination of "IO::AIO::MAP_SHARED" or |
| 1611 | "IO::AIO::MAP_PRIVATE", or a number of system-specific flags (when |
1660 | "IO::AIO::MAP_PRIVATE", or a number of system-specific flags (when |
| 1612 | not available, the are defined as 0): "IO::AIO::MAP_ANONYMOUS" |
1661 | not available, the are 0): "IO::AIO::MAP_ANONYMOUS" (which is set to |
| 1613 | (which is set to "MAP_ANON" if your system only provides this |
1662 | "MAP_ANON" if your system only provides this constant), |
|
|
1663 | "IO::AIO::MAP_LOCKED", "IO::AIO::MAP_NORESERVE", |
| 1614 | constant), "IO::AIO::MAP_HUGETLB", "IO::AIO::MAP_LOCKED", |
1664 | "IO::AIO::MAP_POPULATE", "IO::AIO::MAP_NONBLOCK", |
|
|
1665 | "IO::AIO::MAP_FIXED", "IO::AIO::MAP_GROWSDOWN", |
| 1615 | "IO::AIO::MAP_NORESERVE", "IO::AIO::MAP_POPULATE" or |
1666 | "IO::AIO::MAP_32BIT", "IO::AIO::MAP_HUGETLB" or |
| 1616 | "IO::AIO::MAP_NONBLOCK" |
1667 | "IO::AIO::MAP_STACK". |
| 1617 | |
1668 | |
| 1618 | If $fh is "undef", then a file descriptor of -1 is passed. |
1669 | If $fh is "undef", then a file descriptor of -1 is passed. |
| 1619 | |
1670 | |
| 1620 | $offset is the offset from the start of the file - it generally must |
1671 | $offset is the offset from the start of the file - it generally must |
| 1621 | be a multiple of "IO::AIO::PAGESIZE" and defaults to 0. |
1672 | be a multiple of "IO::AIO::PAGESIZE" and defaults to 0. |
| … | |
… | |
| 1659 | "IO::AIO::SPLICE_F_MORE" and "IO::AIO::SPLICE_F_GIFT". |
1710 | "IO::AIO::SPLICE_F_MORE" and "IO::AIO::SPLICE_F_GIFT". |
| 1660 | |
1711 | |
| 1661 | See the splice(2) manpage for details. |
1712 | See the splice(2) manpage for details. |
| 1662 | |
1713 | |
| 1663 | IO::AIO::tee $r_fh, $w_fh, $length, $flags |
1714 | IO::AIO::tee $r_fh, $w_fh, $length, $flags |
| 1664 | Calls the GNU/Linux tee(2) syscall, see it's manpage and the |
1715 | Calls the GNU/Linux tee(2) syscall, see its manpage and the |
| 1665 | description for "IO::AIO::splice" above for details. |
1716 | description for "IO::AIO::splice" above for details. |
|
|
1717 | |
|
|
1718 | $actual_size = IO::AIO::pipesize $r_fh[, $new_size] |
|
|
1719 | Attempts to query or change the pipe buffer size. Obviously works |
|
|
1720 | only on pipes, and currently works only on GNU/Linux systems, and |
|
|
1721 | fails with -1/"ENOSYS" everywhere else. If anybody knows how to |
|
|
1722 | influence pipe buffer size on other systems, drop me a note. |
|
|
1723 | |
|
|
1724 | ($rfh, $wfh) = IO::AIO::pipe2 [$flags] |
|
|
1725 | This is a direct interface to the Linux pipe2(2) system call. If |
|
|
1726 | $flags is missing or 0, then this should be the same as a call to |
|
|
1727 | perl's built-in "pipe" function and create a new pipe, and works on |
|
|
1728 | systems that lack the pipe2 syscall. On win32, this case invokes |
|
|
1729 | "_pipe (..., 4096, O_BINARY)". |
|
|
1730 | |
|
|
1731 | If $flags is non-zero, it tries to invoke the pipe2 system call with |
|
|
1732 | the given flags (Linux 2.6.27, glibc 2.9). |
|
|
1733 | |
|
|
1734 | On success, the read and write file handles are returned. |
|
|
1735 | |
|
|
1736 | On error, nothing will be returned. If the pipe2 syscall is missing |
|
|
1737 | and $flags is non-zero, fails with "ENOSYS". |
|
|
1738 | |
|
|
1739 | Please refer to pipe2(2) for more info on the $flags, but at the |
|
|
1740 | time of this writing, "IO::AIO::O_CLOEXEC", "IO::AIO::O_NONBLOCK" |
|
|
1741 | and "IO::AIO::O_DIRECT" (Linux 3.4, for packet-based pipes) were |
|
|
1742 | supported. |
| 1666 | |
1743 | |
| 1667 | EVENT LOOP INTEGRATION |
1744 | EVENT LOOP INTEGRATION |
| 1668 | It is recommended to use AnyEvent::AIO to integrate IO::AIO |
1745 | It is recommended to use AnyEvent::AIO to integrate IO::AIO |
| 1669 | automatically into many event loops: |
1746 | automatically into many event loops: |
| 1670 | |
1747 | |
