… | |
… | |
168 | use common::sense; |
168 | use common::sense; |
169 | |
169 | |
170 | use base 'Exporter'; |
170 | use base 'Exporter'; |
171 | |
171 | |
172 | BEGIN { |
172 | BEGIN { |
173 | our $VERSION = '4.15'; |
173 | our $VERSION = '4.18'; |
174 | |
174 | |
175 | our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close |
175 | 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 |
176 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx |
177 | aio_scandir aio_symlink aio_readlink aio_realpath aio_sync |
177 | aio_scandir aio_symlink aio_readlink aio_realpath aio_sync |
178 | aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_fallocate |
178 | aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_allocate |
179 | aio_pathsync aio_readahead aio_fiemap |
179 | aio_pathsync aio_readahead aio_fiemap |
180 | aio_rename aio_link aio_move aio_copy aio_group |
180 | aio_rename aio_link aio_move aio_copy aio_group |
181 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
181 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
182 | aio_chmod aio_utime aio_truncate |
182 | aio_chmod aio_utime aio_truncate |
183 | aio_msync aio_mtouch aio_mlock aio_mlockall |
183 | aio_msync aio_mtouch aio_mlock aio_mlockall |
… | |
… | |
362 | |
362 | |
363 | |
363 | |
364 | =item aio_open $pathname, $flags, $mode, $callback->($fh) |
364 | =item aio_open $pathname, $flags, $mode, $callback->($fh) |
365 | |
365 | |
366 | Asynchronously open or create a file and call the callback with a newly |
366 | Asynchronously open or create a file and call the callback with a newly |
367 | created filehandle for the file. |
367 | created filehandle for the file (or C<undef> in case of an error). |
368 | |
368 | |
369 | The pathname passed to C<aio_open> must be absolute. See API NOTES, above, |
369 | The pathname passed to C<aio_open> must be absolute. See API NOTES, above, |
370 | for an explanation. |
370 | for an explanation. |
371 | |
371 | |
372 | The C<$flags> argument is a bitmask. See the C<Fcntl> module for a |
372 | The C<$flags> argument is a bitmask. See the C<Fcntl> module for a |
… | |
… | |
603 | namemax => 255, |
603 | namemax => 255, |
604 | frsize => 1024, |
604 | frsize => 1024, |
605 | fsid => 1810 |
605 | fsid => 1810 |
606 | } |
606 | } |
607 | |
607 | |
|
|
608 | Here is a (likely partial) list of fsid values used by Linux - it is safe |
|
|
609 | to hardcode these when the $^O is C<linux>: |
|
|
610 | |
|
|
611 | 0x0000adf5 adfs |
|
|
612 | 0x0000adff affs |
|
|
613 | 0x5346414f afs |
|
|
614 | 0x09041934 anon-inode filesystem |
|
|
615 | 0x00000187 autofs |
|
|
616 | 0x42465331 befs |
|
|
617 | 0x1badface bfs |
|
|
618 | 0x42494e4d binfmt_misc |
|
|
619 | 0x9123683e btrfs |
|
|
620 | 0x0027e0eb cgroupfs |
|
|
621 | 0xff534d42 cifs |
|
|
622 | 0x73757245 coda |
|
|
623 | 0x012ff7b7 coh |
|
|
624 | 0x28cd3d45 cramfs |
|
|
625 | 0x453dcd28 cramfs-wend (wrong endianness) |
|
|
626 | 0x64626720 debugfs |
|
|
627 | 0x00001373 devfs |
|
|
628 | 0x00001cd1 devpts |
|
|
629 | 0x0000f15f ecryptfs |
|
|
630 | 0x00414a53 efs |
|
|
631 | 0x0000137d ext |
|
|
632 | 0x0000ef53 ext2/ext3 |
|
|
633 | 0x0000ef51 ext2 |
|
|
634 | 0x00004006 fat |
|
|
635 | 0x65735546 fuseblk |
|
|
636 | 0x65735543 fusectl |
|
|
637 | 0x0bad1dea futexfs |
|
|
638 | 0x01161970 gfs2 |
|
|
639 | 0x47504653 gpfs |
|
|
640 | 0x00004244 hfs |
|
|
641 | 0xf995e849 hpfs |
|
|
642 | 0x958458f6 hugetlbfs |
|
|
643 | 0x2bad1dea inotifyfs |
|
|
644 | 0x00009660 isofs |
|
|
645 | 0x000072b6 jffs2 |
|
|
646 | 0x3153464a jfs |
|
|
647 | 0x6b414653 k-afs |
|
|
648 | 0x0bd00bd0 lustre |
|
|
649 | 0x0000137f minix |
|
|
650 | 0x0000138f minix 30 char names |
|
|
651 | 0x00002468 minix v2 |
|
|
652 | 0x00002478 minix v2 30 char names |
|
|
653 | 0x00004d5a minix v3 |
|
|
654 | 0x19800202 mqueue |
|
|
655 | 0x00004d44 msdos |
|
|
656 | 0x0000564c novell |
|
|
657 | 0x00006969 nfs |
|
|
658 | 0x6e667364 nfsd |
|
|
659 | 0x00003434 nilfs |
|
|
660 | 0x5346544e ntfs |
|
|
661 | 0x00009fa1 openprom |
|
|
662 | 0x7461636F ocfs2 |
|
|
663 | 0x00009fa0 proc |
|
|
664 | 0x6165676c pstorefs |
|
|
665 | 0x0000002f qnx4 |
|
|
666 | 0x858458f6 ramfs |
|
|
667 | 0x52654973 reiserfs |
|
|
668 | 0x00007275 romfs |
|
|
669 | 0x67596969 rpc_pipefs |
|
|
670 | 0x73636673 securityfs |
|
|
671 | 0xf97cff8c selinux |
|
|
672 | 0x0000517b smb |
|
|
673 | 0x534f434b sockfs |
|
|
674 | 0x73717368 squashfs |
|
|
675 | 0x62656572 sysfs |
|
|
676 | 0x012ff7b6 sysv2 |
|
|
677 | 0x012ff7b5 sysv4 |
|
|
678 | 0x01021994 tmpfs |
|
|
679 | 0x15013346 udf |
|
|
680 | 0x00011954 ufs |
|
|
681 | 0x54190100 ufs byteswapped |
|
|
682 | 0x00009fa2 usbdevfs |
|
|
683 | 0x01021997 v9fs |
|
|
684 | 0xa501fcf5 vxfs |
|
|
685 | 0xabba1974 xenfs |
|
|
686 | 0x012ff7b4 xenix |
|
|
687 | 0x58465342 xfs |
|
|
688 | 0x012fd16d xia |
608 | |
689 | |
609 | =item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
690 | =item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
610 | |
691 | |
611 | Works like perl's C<utime> function (including the special case of $atime |
692 | Works like perl's C<utime> function (including the special case of $atime |
612 | and $mtime being undef). Fractional times are supported if the underlying |
693 | and $mtime being undef). Fractional times are supported if the underlying |
… | |
… | |
702 | |
783 | |
703 | |
784 | |
704 | =item aio_realpath $pathname, $callback->($path) |
785 | =item aio_realpath $pathname, $callback->($path) |
705 | |
786 | |
706 | Asynchronously make the path absolute and resolve any symlinks in |
787 | Asynchronously make the path absolute and resolve any symlinks in |
707 | C<$path>. The resulting path only consists of directories (Same as |
788 | C<$path>. The resulting path only consists of directories (same as |
708 | L<Cwd::realpath>). |
789 | L<Cwd::realpath>). |
709 | |
790 | |
710 | This request can be used to get the absolute path of the current working |
791 | This request can be used to get the absolute path of the current working |
711 | directory by passing it a path of F<.> (a single dot). |
792 | directory by passing it a path of F<.> (a single dot). |
712 | |
793 | |
… | |
… | |
1100 | } |
1181 | } |
1101 | |
1182 | |
1102 | =item aio_rmtree $pathname, $callback->($status) |
1183 | =item aio_rmtree $pathname, $callback->($status) |
1103 | |
1184 | |
1104 | Delete a directory tree starting (and including) C<$path>, return the |
1185 | Delete a directory tree starting (and including) C<$path>, return the |
1105 | status of the final C<rmdir> only. This is a composite request that |
1186 | status of the final C<rmdir> only. This is a composite request that |
1106 | uses C<aio_scandir> to recurse into and rmdir directories, and unlink |
1187 | uses C<aio_scandir> to recurse into and rmdir directories, and unlink |
1107 | everything else. |
1188 | everything else. |
1108 | |
1189 | |
1109 | =cut |
1190 | =cut |
1110 | |
1191 | |
… | |
… | |
1230 | |
1311 | |
1231 | This is a rather advanced IO::AIO call, which works best on mmap(2)ed |
1312 | This is a rather advanced IO::AIO call, which works best on mmap(2)ed |
1232 | scalars. |
1313 | scalars. |
1233 | |
1314 | |
1234 | It touches (reads or writes) all memory pages in the specified |
1315 | It touches (reads or writes) all memory pages in the specified |
1235 | range inside the scalar. All caveats and parameters are the same |
1316 | range inside the scalar. All caveats and parameters are the same |
1236 | as for C<aio_msync>, above, except for flags, which must be either |
1317 | as for C<aio_msync>, above, except for flags, which must be either |
1237 | C<0> (which reads all pages and ensures they are instantiated) or |
1318 | C<0> (which reads all pages and ensures they are instantiated) or |
1238 | C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and |
1319 | C<IO::AIO::MT_MODIFY>, which modifies the memory pages (by reading and |
1239 | writing an octet from it, which dirties the page). |
1320 | writing an octet from it, which dirties the page). |
1240 | |
1321 | |
1241 | =item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
1322 | =item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
1242 | |
1323 | |
1243 | This is a rather advanced IO::AIO call, which works best on mmap(2)ed |
1324 | This is a rather advanced IO::AIO call, which works best on mmap(2)ed |
… | |
… | |
1277 | |
1358 | |
1278 | aio_mlockall IO::AIO::MCL_FUTURE; |
1359 | aio_mlockall IO::AIO::MCL_FUTURE; |
1279 | |
1360 | |
1280 | =item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents) |
1361 | =item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents) |
1281 | |
1362 | |
1282 | Queries the extents of the given file (by calling the Linux FIEMAP ioctl, |
1363 | Queries the extents of the given file (by calling the Linux C<FIEMAP> |
1283 | see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If the |
1364 | ioctl, see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If |
1284 | C<ioctl> is not available on your OS, then this request will fail with |
1365 | the ioctl is not available on your OS, then this request will fail with |
1285 | C<ENOSYS>. |
1366 | C<ENOSYS>. |
1286 | |
1367 | |
1287 | C<$start> is the starting offset to query extents for, C<$length> is the |
1368 | C<$start> is the starting offset to query extents for, C<$length> is the |
1288 | size of the range to query - if it is C<undef>, then the whole file will |
1369 | size of the range to query - if it is C<undef>, then the whole file will |
1289 | be queried. |
1370 | be queried. |
… | |
… | |
1444 | will still point to the original directory. Most functions accepting a |
1525 | will still point to the original directory. Most functions accepting a |
1445 | pathname will use the directory fd on newer systems, and the string on |
1526 | pathname will use the directory fd on newer systems, and the string on |
1446 | older systems. Some functions (such as realpath) will always rely on the |
1527 | older systems. Some functions (such as realpath) will always rely on the |
1447 | string form of the pathname. |
1528 | string form of the pathname. |
1448 | |
1529 | |
1449 | So this fucntionality is mainly useful to get some protection against |
1530 | So this functionality is mainly useful to get some protection against |
1450 | C<chdir>, to easily get an absolute path out of a relative path for future |
1531 | C<chdir>, to easily get an absolute path out of a relative path for future |
1451 | reference, and to speed up doing many operations in the same directory |
1532 | reference, and to speed up doing many operations in the same directory |
1452 | (e.g. when stat'ing all files in a directory). |
1533 | (e.g. when stat'ing all files in a directory). |
1453 | |
1534 | |
1454 | The following functions implement this working directory abstraction: |
1535 | The following functions implement this working directory abstraction: |
… | |
… | |
1475 | =item IO::AIO::CWD |
1556 | =item IO::AIO::CWD |
1476 | |
1557 | |
1477 | This is a compiletime constant (object) that represents the process |
1558 | This is a compiletime constant (object) that represents the process |
1478 | current working directory. |
1559 | current working directory. |
1479 | |
1560 | |
1480 | Specifying this object as working directory object for a pathname is as |
1561 | Specifying this object as working directory object for a pathname is as if |
1481 | if the pathname would be specified directly, without a directory object, |
1562 | the pathname would be specified directly, without a directory object. For |
1482 | e.g., these calls are functionally identical: |
1563 | example, these calls are functionally identical: |
1483 | |
1564 | |
1484 | aio_stat "somefile", sub { ... }; |
1565 | aio_stat "somefile", sub { ... }; |
1485 | aio_stat [IO::AIO::CWD, "somefile"], sub { ... }; |
1566 | aio_stat [IO::AIO::CWD, "somefile"], sub { ... }; |
1486 | |
1567 | |
1487 | =back |
1568 | =back |
|
|
1569 | |
|
|
1570 | To recover the path associated with an IO::AIO::WD object, you can use |
|
|
1571 | C<aio_realpath>: |
|
|
1572 | |
|
|
1573 | aio_realpath $wd, sub { |
|
|
1574 | warn "path is $_[0]\n"; |
|
|
1575 | }; |
1488 | |
1576 | |
1489 | |
1577 | |
1490 | =head2 IO::AIO::REQ CLASS |
1578 | =head2 IO::AIO::REQ CLASS |
1491 | |
1579 | |
1492 | All non-aggregate C<aio_*> functions return an object of this class when |
1580 | All non-aggregate C<aio_*> functions return an object of this class when |
… | |
… | |
1671 | |
1759 | |
1672 | See C<poll_cb> for an example. |
1760 | See C<poll_cb> for an example. |
1673 | |
1761 | |
1674 | =item IO::AIO::poll_cb |
1762 | =item IO::AIO::poll_cb |
1675 | |
1763 | |
1676 | Process some outstanding events on the result pipe. You have to call |
1764 | Process some requests that have reached the result phase (i.e. they have |
|
|
1765 | been executed but the results are not yet reported). You have to call |
|
|
1766 | this "regularly" to finish outstanding requests. |
|
|
1767 | |
1677 | this regularly. Returns C<0> if all events could be processed (or there |
1768 | Returns C<0> if all events could be processed (or there were no |
1678 | were no events to process), or C<-1> if it returned earlier for whatever |
1769 | events to process), or C<-1> if it returned earlier for whatever |
1679 | reason. Returns immediately when no events are outstanding. The amount of |
1770 | reason. Returns immediately when no events are outstanding. The amount |
1680 | events processed depends on the settings of C<IO::AIO::max_poll_req> and |
1771 | of events processed depends on the settings of C<IO::AIO::max_poll_req>, |
1681 | C<IO::AIO::max_poll_time>. |
1772 | C<IO::AIO::max_poll_time> and C<IO::AIO::max_outstanding>. |
1682 | |
1773 | |
1683 | If not all requests were processed for whatever reason, the filehandle |
1774 | If not all requests were processed for whatever reason, the poll file |
1684 | will still be ready when C<poll_cb> returns, so normally you don't have to |
1775 | descriptor will still be ready when C<poll_cb> returns, so normally you |
1685 | do anything special to have it called later. |
1776 | don't have to do anything special to have it called later. |
1686 | |
1777 | |
1687 | Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes |
1778 | Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes |
1688 | ready, it can be beneficial to call this function from loops which submit |
1779 | ready, it can be beneficial to call this function from loops which submit |
1689 | a lot of requests, to make sure the results get processed when they become |
1780 | a lot of requests, to make sure the results get processed when they become |
1690 | available and not just when the loop is finished and the event loop takes |
1781 | available and not just when the loop is finished and the event loop takes |
… | |
… | |
1699 | poll => 'r', async => 1, |
1790 | poll => 'r', async => 1, |
1700 | cb => \&IO::AIO::poll_cb); |
1791 | cb => \&IO::AIO::poll_cb); |
1701 | |
1792 | |
1702 | =item IO::AIO::poll_wait |
1793 | =item IO::AIO::poll_wait |
1703 | |
1794 | |
1704 | If there are any outstanding requests and none of them in the result |
1795 | Wait until either at least one request is in the result phase or no |
1705 | phase, wait till the result filehandle becomes ready for reading (simply |
1796 | requests are outstanding anymore. |
1706 | does a C<select> on the filehandle. This is useful if you want to |
1797 | |
1707 | synchronously wait for some requests to finish). |
1798 | This is useful if you want to synchronously wait for some requests to |
|
|
1799 | become ready, without actually handling them. |
1708 | |
1800 | |
1709 | See C<nreqs> for an example. |
1801 | See C<nreqs> for an example. |
1710 | |
1802 | |
1711 | =item IO::AIO::poll |
1803 | =item IO::AIO::poll |
1712 | |
1804 | |