ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/IO-AIO/AIO.pm
(Generate patch)

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.227 by root, Tue May 29 03:58:02 2012 UTC vs.
Revision 1.240 by root, Mon Dec 17 06:18:39 2012 UTC

168use common::sense; 168use common::sense;
169 169
170use base 'Exporter'; 170use base 'Exporter';
171 171
172BEGIN { 172BEGIN {
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
202 202
203=head1 FUNCTIONS 203=head1 FUNCTIONS
204 204
205=head2 QUICK OVERVIEW 205=head2 QUICK OVERVIEW
206 206
207This section simply lists the prototypes of the most important functions 207This section simply lists the prototypes most of the functions for
208for quick reference. See the following sections for function-by-function 208quick reference. See the following sections for function-by-function
209documentation. 209documentation.
210 210
211 aio_wd $pathname, $callback->($wd) 211 aio_wd $pathname, $callback->($wd)
212 aio_open $pathname, $flags, $mode, $callback->($fh) 212 aio_open $pathname, $flags, $mode, $callback->($fh)
213 aio_close $fh, $callback->($status) 213 aio_close $fh, $callback->($status)
221 aio_statvfs $fh_or_path, $callback->($statvfs) 221 aio_statvfs $fh_or_path, $callback->($statvfs)
222 aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 222 aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
223 aio_chown $fh_or_path, $uid, $gid, $callback->($status) 223 aio_chown $fh_or_path, $uid, $gid, $callback->($status)
224 aio_chmod $fh_or_path, $mode, $callback->($status) 224 aio_chmod $fh_or_path, $mode, $callback->($status)
225 aio_truncate $fh_or_path, $offset, $callback->($status) 225 aio_truncate $fh_or_path, $offset, $callback->($status)
226 aio_allocate $fh, $mode, $offset, $len, $callback->($status)
227 aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
226 aio_unlink $pathname, $callback->($status) 228 aio_unlink $pathname, $callback->($status)
227 aio_mknod $pathname, $mode, $dev, $callback->($status) 229 aio_mknod $pathname, $mode, $dev, $callback->($status)
228 aio_link $srcpath, $dstpath, $callback->($status) 230 aio_link $srcpath, $dstpath, $callback->($status)
229 aio_symlink $srcpath, $dstpath, $callback->($status) 231 aio_symlink $srcpath, $dstpath, $callback->($status)
230 aio_readlink $pathname, $callback->($link) 232 aio_readlink $pathname, $callback->($link)
360 362
361 363
362=item aio_open $pathname, $flags, $mode, $callback->($fh) 364=item aio_open $pathname, $flags, $mode, $callback->($fh)
363 365
364Asynchronously open or create a file and call the callback with a newly 366Asynchronously open or create a file and call the callback with a newly
365created filehandle for the file. 367created filehandle for the file (or C<undef> in case of an error).
366 368
367The pathname passed to C<aio_open> must be absolute. See API NOTES, above, 369The pathname passed to C<aio_open> must be absolute. See API NOTES, above,
368for an explanation. 370for an explanation.
369 371
370The C<$flags> argument is a bitmask. See the C<Fcntl> module for a 372The C<$flags> argument is a bitmask. See the C<Fcntl> module for a
601 namemax => 255, 603 namemax => 255,
602 frsize => 1024, 604 frsize => 1024,
603 fsid => 1810 605 fsid => 1810
604 } 606 }
605 607
608Here is a (likely partial) list of fsid values used by Linux - it is safe
609to 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
606 689
607=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 690=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
608 691
609Works like perl's C<utime> function (including the special case of $atime 692Works like perl's C<utime> function (including the special case of $atime
610and $mtime being undef). Fractional times are supported if the underlying 693and $mtime being undef). Fractional times are supported if the underlying
638=item aio_truncate $fh_or_path, $offset, $callback->($status) 721=item aio_truncate $fh_or_path, $offset, $callback->($status)
639 722
640Works like truncate(2) or ftruncate(2). 723Works like truncate(2) or ftruncate(2).
641 724
642 725
726=item aio_allocate $fh, $mode, $offset, $len, $callback->($status)
727
728Allocates or freed disk space according to the C<$mode> argument. See the
729linux C<fallocate> docuemntation for details.
730
731C<$mode> can currently be C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE>
732to allocate space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE |
733IO::AIO::FALLOC_FL_KEEP_SIZE>, to deallocate a file range.
734
735The file system block size used by C<fallocate> is presumably the
736C<f_bsize> returned by C<statvfs>.
737
738If C<fallocate> isn't available or cannot be emulated (currently no
739emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>.
740
741
643=item aio_chmod $fh_or_path, $mode, $callback->($status) 742=item aio_chmod $fh_or_path, $mode, $callback->($status)
644 743
645Works like perl's C<chmod> function. 744Works like perl's C<chmod> function.
646 745
647 746
684 783
685 784
686=item aio_realpath $pathname, $callback->($path) 785=item aio_realpath $pathname, $callback->($path)
687 786
688Asynchronously make the path absolute and resolve any symlinks in 787Asynchronously make the path absolute and resolve any symlinks in
689C<$path>. The resulting path only consists of directories (Same as 788C<$path>. The resulting path only consists of directories (same as
690L<Cwd::realpath>). 789L<Cwd::realpath>).
691 790
692This request can be used to get the absolute path of the current working 791This request can be used to get the absolute path of the current working
693directory by passing it a path of F<.> (a single dot). 792directory by passing it a path of F<.> (a single dot).
694 793
1082} 1181}
1083 1182
1084=item aio_rmtree $pathname, $callback->($status) 1183=item aio_rmtree $pathname, $callback->($status)
1085 1184
1086Delete a directory tree starting (and including) C<$path>, return the 1185Delete a directory tree starting (and including) C<$path>, return the
1087status of the final C<rmdir> only. This is a composite request that 1186status of the final C<rmdir> only. This is a composite request that
1088uses C<aio_scandir> to recurse into and rmdir directories, and unlink 1187uses C<aio_scandir> to recurse into and rmdir directories, and unlink
1089everything else. 1188everything else.
1090 1189
1091=cut 1190=cut
1092 1191
1212 1311
1213This is a rather advanced IO::AIO call, which works best on mmap(2)ed 1312This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1214scalars. 1313scalars.
1215 1314
1216It touches (reads or writes) all memory pages in the specified 1315It touches (reads or writes) all memory pages in the specified
1217range inside the scalar. All caveats and parameters are the same 1316range inside the scalar. All caveats and parameters are the same
1218as for C<aio_msync>, above, except for flags, which must be either 1317as for C<aio_msync>, above, except for flags, which must be either
1219C<0> (which reads all pages and ensures they are instantiated) or 1318C<0> (which reads all pages and ensures they are instantiated) or
1220C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and 1319C<IO::AIO::MT_MODIFY>, which modifies the memory pages (by reading and
1221writing an octet from it, which dirties the page). 1320writing an octet from it, which dirties the page).
1222 1321
1223=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) 1322=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
1224 1323
1225This is a rather advanced IO::AIO call, which works best on mmap(2)ed 1324This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1259 1358
1260 aio_mlockall IO::AIO::MCL_FUTURE; 1359 aio_mlockall IO::AIO::MCL_FUTURE;
1261 1360
1262=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents) 1361=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
1263 1362
1264Queries the extents of the given file (by calling the Linux FIEMAP ioctl, 1363Queries the extents of the given file (by calling the Linux C<FIEMAP>
1265see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If the 1364ioctl, see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If
1266C<ioctl> is not available on your OS, then this rquiest will fail with 1365the ioctl is not available on your OS, then this request will fail with
1267C<ENOSYS>. 1366C<ENOSYS>.
1268 1367
1269C<$start> is the starting offset to query extents for, C<$length> is the 1368C<$start> is the starting offset to query extents for, C<$length> is the
1270size of the range to query - if it is C<undef>, then the whole file will 1369size of the range to query - if it is C<undef>, then the whole file will
1271be queried. 1370be queried.
1274C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also 1373C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also
1275exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query 1374exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query
1276the data portion. 1375the data portion.
1277 1376
1278C<$count> is the maximum number of extent records to return. If it is 1377C<$count> is the maximum number of extent records to return. If it is
1279C<undef>, then IO::AIO queries all extents of the file. As a very special 1378C<undef>, then IO::AIO queries all extents of the range. As a very special
1280case, if it is C<0>, then the callback receives the number of extents 1379case, if it is C<0>, then the callback receives the number of extents
1281instead of the extents themselves. 1380instead of the extents themselves (which is unreliable, see below).
1282 1381
1283If an error occurs, the callback receives no arguments. The special 1382If an error occurs, the callback receives no arguments. The special
1284C<errno> value C<IO::AIO::EBADR> is available to test for flag errors. 1383C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.
1285 1384
1286Otherwise, the callback receives an array reference with extent 1385Otherwise, the callback receives an array reference with extent
1288following members: 1387following members:
1289 1388
1290 [$logical, $physical, $length, $flags] 1389 [$logical, $physical, $length, $flags]
1291 1390
1292Flags is any combination of the following flag values (typically either C<0> 1391Flags is any combination of the following flag values (typically either C<0>
1293or C<IO::AIO::FIEMAP_EXTENT_LAST>): 1392or C<IO::AIO::FIEMAP_EXTENT_LAST> (1)):
1294 1393
1295C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>, 1394C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,
1296C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>, 1395C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,
1297C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>, 1396C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,
1298C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>, 1397C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,
1299C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or 1398C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or
1300C<IO::AIO::FIEMAP_EXTENT_SHARED>. 1399C<IO::AIO::FIEMAP_EXTENT_SHARED>.
1400
1401At the time of this writing (Linux 3.2), this requets is unreliable unless
1402C<$count> is C<undef>, as the kernel has all sorts of bugs preventing
1403it to return all extents of a range for files with large number of
1404extents. The code works around all these issues if C<$count> is undef.
1301 1405
1302=item aio_group $callback->(...) 1406=item aio_group $callback->(...)
1303 1407
1304This is a very special aio request: Instead of doing something, it is a 1408This is a very special aio request: Instead of doing something, it is a
1305container for other aio requests, which is useful if you want to bundle 1409container for other aio requests, which is useful if you want to bundle
1421will still point to the original directory. Most functions accepting a 1525will still point to the original directory. Most functions accepting a
1422pathname will use the directory fd on newer systems, and the string on 1526pathname will use the directory fd on newer systems, and the string on
1423older systems. Some functions (such as realpath) will always rely on the 1527older systems. Some functions (such as realpath) will always rely on the
1424string form of the pathname. 1528string form of the pathname.
1425 1529
1426So this fucntionality is mainly useful to get some protection against 1530So this functionality is mainly useful to get some protection against
1427C<chdir>, to easily get an absolute path out of a relative path for future 1531C<chdir>, to easily get an absolute path out of a relative path for future
1428reference, and to speed up doing many operations in the same directory 1532reference, and to speed up doing many operations in the same directory
1429(e.g. when stat'ing all files in a directory). 1533(e.g. when stat'ing all files in a directory).
1430 1534
1431The following functions implement this working directory abstraction: 1535The following functions implement this working directory abstraction:
1452=item IO::AIO::CWD 1556=item IO::AIO::CWD
1453 1557
1454This is a compiletime constant (object) that represents the process 1558This is a compiletime constant (object) that represents the process
1455current working directory. 1559current working directory.
1456 1560
1457Specifying this object as working directory object for a pathname is as 1561Specifying this object as working directory object for a pathname is as if
1458if the pathname would be specified directly, without a directory object, 1562the pathname would be specified directly, without a directory object. For
1459e.g., these calls are functionally identical: 1563example, these calls are functionally identical:
1460 1564
1461 aio_stat "somefile", sub { ... }; 1565 aio_stat "somefile", sub { ... };
1462 aio_stat [IO::AIO::CWD, "somefile"], sub { ... }; 1566 aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
1463 1567
1464=back 1568=back
1569
1570To recover the path associated with an IO::AIO::WD object, you can use
1571C<aio_realpath>:
1572
1573 aio_realpath $wd, sub {
1574 warn "path is $_[0]\n";
1575 };
1465 1576
1466 1577
1467=head2 IO::AIO::REQ CLASS 1578=head2 IO::AIO::REQ CLASS
1468 1579
1469All non-aggregate C<aio_*> functions return an object of this class when 1580All non-aggregate C<aio_*> functions return an object of this class when
1648 1759
1649See C<poll_cb> for an example. 1760See C<poll_cb> for an example.
1650 1761
1651=item IO::AIO::poll_cb 1762=item IO::AIO::poll_cb
1652 1763
1653Process some outstanding events on the result pipe. You have to call 1764Process some requests that have reached the result phase (i.e. they have
1765been executed but the results are not yet reported). You have to call
1766this "regularly" to finish outstanding requests.
1767
1654this regularly. Returns C<0> if all events could be processed (or there 1768Returns C<0> if all events could be processed (or there were no
1655were no events to process), or C<-1> if it returned earlier for whatever 1769events to process), or C<-1> if it returned earlier for whatever
1656reason. Returns immediately when no events are outstanding. The amount of 1770reason. Returns immediately when no events are outstanding. The amount
1657events processed depends on the settings of C<IO::AIO::max_poll_req> and 1771of events processed depends on the settings of C<IO::AIO::max_poll_req>,
1658C<IO::AIO::max_poll_time>. 1772C<IO::AIO::max_poll_time> and C<IO::AIO::max_outstanding>.
1659 1773
1660If not all requests were processed for whatever reason, the filehandle 1774If not all requests were processed for whatever reason, the poll file
1661will still be ready when C<poll_cb> returns, so normally you don't have to 1775descriptor will still be ready when C<poll_cb> returns, so normally you
1662do anything special to have it called later. 1776don't have to do anything special to have it called later.
1663 1777
1664Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes 1778Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes
1665ready, it can be beneficial to call this function from loops which submit 1779ready, it can be beneficial to call this function from loops which submit
1666a lot of requests, to make sure the results get processed when they become 1780a lot of requests, to make sure the results get processed when they become
1667available and not just when the loop is finished and the event loop takes 1781available and not just when the loop is finished and the event loop takes
1676 poll => 'r', async => 1, 1790 poll => 'r', async => 1,
1677 cb => \&IO::AIO::poll_cb); 1791 cb => \&IO::AIO::poll_cb);
1678 1792
1679=item IO::AIO::poll_wait 1793=item IO::AIO::poll_wait
1680 1794
1681If there are any outstanding requests and none of them in the result 1795Wait until either at least one request is in the result phase or no
1682phase, wait till the result filehandle becomes ready for reading (simply 1796requests are outstanding anymore.
1683does a C<select> on the filehandle. This is useful if you want to 1797
1684synchronously wait for some requests to finish). 1798This is useful if you want to synchronously wait for some requests to
1799become ready, without actually handling them.
1685 1800
1686See C<nreqs> for an example. 1801See C<nreqs> for an example.
1687 1802
1688=item IO::AIO::poll 1803=item IO::AIO::poll
1689 1804
1908ENOSYS, otherwise the return value of C<mprotect>. 2023ENOSYS, otherwise the return value of C<mprotect>.
1909 2024
1910=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] 2025=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
1911 2026
1912Memory-maps a file (or anonymous memory range) and attaches it to the 2027Memory-maps a file (or anonymous memory range) and attaches it to the
1913given C<$scalar>, which will act like a string scalar. 2028given C<$scalar>, which will act like a string scalar. Returns true on
2029success, and false otherwise.
1914 2030
1915The only operations allowed on the scalar are C<substr>/C<vec> that don't 2031The only operations allowed on the scalar are C<substr>/C<vec> that don't
1916change the string length, and most read-only operations such as copying it 2032change the string length, and most read-only operations such as copying it
1917or searching it with regexes and so on. 2033or searching it with regexes and so on.
1918 2034

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines