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.229 by root, Wed Jul 25 16:32:30 2012 UTC vs.
Revision 1.243 by root, Sat Sep 7 23:18:23 2013 UTC

68=head2 EXAMPLE 68=head2 EXAMPLE
69 69
70This is a simple example that uses the EV module and loads 70This is a simple example that uses the EV module and loads
71F</etc/passwd> asynchronously: 71F</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;
168use common::sense; 167use common::sense;
169 168
170use base 'Exporter'; 169use base 'Exporter';
171 170
172BEGIN { 171BEGIN {
173 our $VERSION = '4.15'; 172 our $VERSION = '4.19';
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_fallocate 177 aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_allocate
179 aio_pathsync aio_readahead aio_fiemap 178 aio_pathsync aio_readahead aio_fiemap
180 aio_rename aio_link aio_move aio_copy aio_group 179 aio_rename aio_link aio_move aio_copy aio_group
181 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown 180 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
182 aio_chmod aio_utime aio_truncate 181 aio_chmod aio_utime aio_truncate
183 aio_msync aio_mtouch aio_mlock aio_mlockall 182 aio_msync aio_mtouch aio_mlock aio_mlockall
202 201
203=head1 FUNCTIONS 202=head1 FUNCTIONS
204 203
205=head2 QUICK OVERVIEW 204=head2 QUICK OVERVIEW
206 205
207This section simply lists the prototypes of the most important functions 206This section simply lists the prototypes most of the functions for
208for quick reference. See the following sections for function-by-function 207quick reference. See the following sections for function-by-function
209documentation. 208documentation.
210 209
211 aio_wd $pathname, $callback->($wd) 210 aio_wd $pathname, $callback->($wd)
212 aio_open $pathname, $flags, $mode, $callback->($fh) 211 aio_open $pathname, $flags, $mode, $callback->($fh)
213 aio_close $fh, $callback->($status) 212 aio_close $fh, $callback->($status)
222 aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 221 aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
223 aio_chown $fh_or_path, $uid, $gid, $callback->($status) 222 aio_chown $fh_or_path, $uid, $gid, $callback->($status)
224 aio_chmod $fh_or_path, $mode, $callback->($status) 223 aio_chmod $fh_or_path, $mode, $callback->($status)
225 aio_truncate $fh_or_path, $offset, $callback->($status) 224 aio_truncate $fh_or_path, $offset, $callback->($status)
226 aio_allocate $fh, $mode, $offset, $len, $callback->($status) 225 aio_allocate $fh, $mode, $offset, $len, $callback->($status)
226 aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
227 aio_unlink $pathname, $callback->($status) 227 aio_unlink $pathname, $callback->($status)
228 aio_mknod $pathname, $mode, $dev, $callback->($status) 228 aio_mknod $pathname, $mode, $dev, $callback->($status)
229 aio_link $srcpath, $dstpath, $callback->($status) 229 aio_link $srcpath, $dstpath, $callback->($status)
230 aio_symlink $srcpath, $dstpath, $callback->($status) 230 aio_symlink $srcpath, $dstpath, $callback->($status)
231 aio_readlink $pathname, $callback->($link) 231 aio_readlink $pathname, $callback->($link)
361 361
362 362
363=item aio_open $pathname, $flags, $mode, $callback->($fh) 363=item aio_open $pathname, $flags, $mode, $callback->($fh)
364 364
365Asynchronously open or create a file and call the callback with a newly 365Asynchronously open or create a file and call the callback with a newly
366created filehandle for the file. 366created filehandle for the file (or C<undef> in case of an error).
367 367
368The pathname passed to C<aio_open> must be absolute. See API NOTES, above, 368The pathname passed to C<aio_open> must be absolute. See API NOTES, above,
369for an explanation. 369for an explanation.
370 370
371The C<$flags> argument is a bitmask. See the C<Fcntl> module for a 371The C<$flags> argument is a bitmask. See the C<Fcntl> module for a
602 namemax => 255, 602 namemax => 255,
603 frsize => 1024, 603 frsize => 1024,
604 fsid => 1810 604 fsid => 1810
605 } 605 }
606 606
607Here is a (likely partial) list of fsid values used by Linux - it is safe
608to hardcode these when the $^O is C<linux>:
609
610 0x0000adf5 adfs
611 0x0000adff affs
612 0x5346414f afs
613 0x09041934 anon-inode filesystem
614 0x00000187 autofs
615 0x42465331 befs
616 0x1badface bfs
617 0x42494e4d binfmt_misc
618 0x9123683e btrfs
619 0x0027e0eb cgroupfs
620 0xff534d42 cifs
621 0x73757245 coda
622 0x012ff7b7 coh
623 0x28cd3d45 cramfs
624 0x453dcd28 cramfs-wend (wrong endianness)
625 0x64626720 debugfs
626 0x00001373 devfs
627 0x00001cd1 devpts
628 0x0000f15f ecryptfs
629 0x00414a53 efs
630 0x0000137d ext
631 0x0000ef53 ext2/ext3
632 0x0000ef51 ext2
633 0x00004006 fat
634 0x65735546 fuseblk
635 0x65735543 fusectl
636 0x0bad1dea futexfs
637 0x01161970 gfs2
638 0x47504653 gpfs
639 0x00004244 hfs
640 0xf995e849 hpfs
641 0x958458f6 hugetlbfs
642 0x2bad1dea inotifyfs
643 0x00009660 isofs
644 0x000072b6 jffs2
645 0x3153464a jfs
646 0x6b414653 k-afs
647 0x0bd00bd0 lustre
648 0x0000137f minix
649 0x0000138f minix 30 char names
650 0x00002468 minix v2
651 0x00002478 minix v2 30 char names
652 0x00004d5a minix v3
653 0x19800202 mqueue
654 0x00004d44 msdos
655 0x0000564c novell
656 0x00006969 nfs
657 0x6e667364 nfsd
658 0x00003434 nilfs
659 0x5346544e ntfs
660 0x00009fa1 openprom
661 0x7461636F ocfs2
662 0x00009fa0 proc
663 0x6165676c pstorefs
664 0x0000002f qnx4
665 0x858458f6 ramfs
666 0x52654973 reiserfs
667 0x00007275 romfs
668 0x67596969 rpc_pipefs
669 0x73636673 securityfs
670 0xf97cff8c selinux
671 0x0000517b smb
672 0x534f434b sockfs
673 0x73717368 squashfs
674 0x62656572 sysfs
675 0x012ff7b6 sysv2
676 0x012ff7b5 sysv4
677 0x01021994 tmpfs
678 0x15013346 udf
679 0x00011954 ufs
680 0x54190100 ufs byteswapped
681 0x00009fa2 usbdevfs
682 0x01021997 v9fs
683 0xa501fcf5 vxfs
684 0xabba1974 xenfs
685 0x012ff7b4 xenix
686 0x58465342 xfs
687 0x012fd16d xia
607 688
608=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 689=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
609 690
610Works like perl's C<utime> function (including the special case of $atime 691Works like perl's C<utime> function (including the special case of $atime
611and $mtime being undef). Fractional times are supported if the underlying 692and $mtime being undef). Fractional times are supported if the underlying
701 782
702 783
703=item aio_realpath $pathname, $callback->($path) 784=item aio_realpath $pathname, $callback->($path)
704 785
705Asynchronously make the path absolute and resolve any symlinks in 786Asynchronously make the path absolute and resolve any symlinks in
706C<$path>. The resulting path only consists of directories (Same as 787C<$path>. The resulting path only consists of directories (same as
707L<Cwd::realpath>). 788L<Cwd::realpath>).
708 789
709This request can be used to get the absolute path of the current working 790This request can be used to get the absolute path of the current working
710directory by passing it a path of F<.> (a single dot). 791directory by passing it a path of F<.> (a single dot).
711 792
712 793
713=item aio_rename $srcpath, $dstpath, $callback->($status) 794=item aio_rename $srcpath, $dstpath, $callback->($status)
714 795
715Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as 796Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
716rename(2) and call the callback with the result code. 797rename(2) and call the callback with the result code.
798
799On systems that support the AIO::WD working directory abstraction
800natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead
801of failing, C<rename> is called on the absolute path of C<$wd>.
717 802
718 803
719=item aio_mkdir $pathname, $mode, $callback->($status) 804=item aio_mkdir $pathname, $mode, $callback->($status)
720 805
721Asynchronously mkdir (create) a directory and call the callback with 806Asynchronously mkdir (create) a directory and call the callback with
725 810
726=item aio_rmdir $pathname, $callback->($status) 811=item aio_rmdir $pathname, $callback->($status)
727 812
728Asynchronously rmdir (delete) a directory and call the callback with the 813Asynchronously rmdir (delete) a directory and call the callback with the
729result code. 814result code.
815
816On systems that support the AIO::WD working directory abstraction
817natively, the case C<[$wd, "."]> is specialcased - instead of failing,
818C<rmdir> is called on the absolute path of C<$wd>.
730 819
731 820
732=item aio_readdir $pathname, $callback->($entries) 821=item aio_readdir $pathname, $callback->($entries)
733 822
734Unlike the POSIX call of the same name, C<aio_readdir> reads an entire 823Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
1099} 1188}
1100 1189
1101=item aio_rmtree $pathname, $callback->($status) 1190=item aio_rmtree $pathname, $callback->($status)
1102 1191
1103Delete a directory tree starting (and including) C<$path>, return the 1192Delete a directory tree starting (and including) C<$path>, return the
1104status of the final C<rmdir> only. This is a composite request that 1193status of the final C<rmdir> only. This is a composite request that
1105uses C<aio_scandir> to recurse into and rmdir directories, and unlink 1194uses C<aio_scandir> to recurse into and rmdir directories, and unlink
1106everything else. 1195everything else.
1107 1196
1108=cut 1197=cut
1109 1198
1229 1318
1230This is a rather advanced IO::AIO call, which works best on mmap(2)ed 1319This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1231scalars. 1320scalars.
1232 1321
1233It touches (reads or writes) all memory pages in the specified 1322It touches (reads or writes) all memory pages in the specified
1234range inside the scalar. All caveats and parameters are the same 1323range inside the scalar. All caveats and parameters are the same
1235as for C<aio_msync>, above, except for flags, which must be either 1324as for C<aio_msync>, above, except for flags, which must be either
1236C<0> (which reads all pages and ensures they are instantiated) or 1325C<0> (which reads all pages and ensures they are instantiated) or
1237C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and 1326C<IO::AIO::MT_MODIFY>, which modifies the memory pages (by reading and
1238writing an octet from it, which dirties the page). 1327writing an octet from it, which dirties the page).
1239 1328
1240=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) 1329=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
1241 1330
1242This is a rather advanced IO::AIO call, which works best on mmap(2)ed 1331This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1276 1365
1277 aio_mlockall IO::AIO::MCL_FUTURE; 1366 aio_mlockall IO::AIO::MCL_FUTURE;
1278 1367
1279=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents) 1368=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
1280 1369
1281Queries the extents of the given file (by calling the Linux FIEMAP ioctl, 1370Queries the extents of the given file (by calling the Linux C<FIEMAP>
1282see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If the 1371ioctl, see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If
1283C<ioctl> is not available on your OS, then this rquiest will fail with 1372the ioctl is not available on your OS, then this request will fail with
1284C<ENOSYS>. 1373C<ENOSYS>.
1285 1374
1286C<$start> is the starting offset to query extents for, C<$length> is the 1375C<$start> is the starting offset to query extents for, C<$length> is the
1287size of the range to query - if it is C<undef>, then the whole file will 1376size of the range to query - if it is C<undef>, then the whole file will
1288be queried. 1377be queried.
1291C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also 1380C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also
1292exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query 1381exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query
1293the data portion. 1382the data portion.
1294 1383
1295C<$count> is the maximum number of extent records to return. If it is 1384C<$count> is the maximum number of extent records to return. If it is
1296C<undef>, then IO::AIO queries all extents of the file. As a very special 1385C<undef>, then IO::AIO queries all extents of the range. As a very special
1297case, if it is C<0>, then the callback receives the number of extents 1386case, if it is C<0>, then the callback receives the number of extents
1298instead of the extents themselves. 1387instead of the extents themselves (which is unreliable, see below).
1299 1388
1300If an error occurs, the callback receives no arguments. The special 1389If an error occurs, the callback receives no arguments. The special
1301C<errno> value C<IO::AIO::EBADR> is available to test for flag errors. 1390C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.
1302 1391
1303Otherwise, the callback receives an array reference with extent 1392Otherwise, the callback receives an array reference with extent
1305following members: 1394following members:
1306 1395
1307 [$logical, $physical, $length, $flags] 1396 [$logical, $physical, $length, $flags]
1308 1397
1309Flags is any combination of the following flag values (typically either C<0> 1398Flags is any combination of the following flag values (typically either C<0>
1310or C<IO::AIO::FIEMAP_EXTENT_LAST>): 1399or C<IO::AIO::FIEMAP_EXTENT_LAST> (1)):
1311 1400
1312C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>, 1401C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,
1313C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>, 1402C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,
1314C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>, 1403C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,
1315C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>, 1404C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,
1316C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or 1405C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or
1317C<IO::AIO::FIEMAP_EXTENT_SHARED>. 1406C<IO::AIO::FIEMAP_EXTENT_SHARED>.
1407
1408At the time of this writing (Linux 3.2), this requets is unreliable unless
1409C<$count> is C<undef>, as the kernel has all sorts of bugs preventing
1410it to return all extents of a range for files with large number of
1411extents. The code works around all these issues if C<$count> is undef.
1318 1412
1319=item aio_group $callback->(...) 1413=item aio_group $callback->(...)
1320 1414
1321This is a very special aio request: Instead of doing something, it is a 1415This is a very special aio request: Instead of doing something, it is a
1322container for other aio requests, which is useful if you want to bundle 1416container for other aio requests, which is useful if you want to bundle
1438will still point to the original directory. Most functions accepting a 1532will still point to the original directory. Most functions accepting a
1439pathname will use the directory fd on newer systems, and the string on 1533pathname will use the directory fd on newer systems, and the string on
1440older systems. Some functions (such as realpath) will always rely on the 1534older systems. Some functions (such as realpath) will always rely on the
1441string form of the pathname. 1535string form of the pathname.
1442 1536
1443So this fucntionality is mainly useful to get some protection against 1537So this functionality is mainly useful to get some protection against
1444C<chdir>, to easily get an absolute path out of a relative path for future 1538C<chdir>, to easily get an absolute path out of a relative path for future
1445reference, and to speed up doing many operations in the same directory 1539reference, and to speed up doing many operations in the same directory
1446(e.g. when stat'ing all files in a directory). 1540(e.g. when stat'ing all files in a directory).
1447 1541
1448The following functions implement this working directory abstraction: 1542The following functions implement this working directory abstraction:
1469=item IO::AIO::CWD 1563=item IO::AIO::CWD
1470 1564
1471This is a compiletime constant (object) that represents the process 1565This is a compiletime constant (object) that represents the process
1472current working directory. 1566current working directory.
1473 1567
1474Specifying this object as working directory object for a pathname is as 1568Specifying this object as working directory object for a pathname is as if
1475if the pathname would be specified directly, without a directory object, 1569the pathname would be specified directly, without a directory object. For
1476e.g., these calls are functionally identical: 1570example, these calls are functionally identical:
1477 1571
1478 aio_stat "somefile", sub { ... }; 1572 aio_stat "somefile", sub { ... };
1479 aio_stat [IO::AIO::CWD, "somefile"], sub { ... }; 1573 aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
1480 1574
1481=back 1575=back
1482 1576
1577To recover the path associated with an IO::AIO::WD object, you can use
1578C<aio_realpath>:
1579
1580 aio_realpath $wd, sub {
1581 warn "path is $_[0]\n";
1582 };
1583
1584Currently, C<aio_statvfs> always, and C<aio_rename> and C<aio_rmdir>
1585sometimes, fall back to using an absolue path.
1483 1586
1484=head2 IO::AIO::REQ CLASS 1587=head2 IO::AIO::REQ CLASS
1485 1588
1486All non-aggregate C<aio_*> functions return an object of this class when 1589All non-aggregate C<aio_*> functions return an object of this class when
1487called in non-void context. 1590called in non-void context.
1665 1768
1666See C<poll_cb> for an example. 1769See C<poll_cb> for an example.
1667 1770
1668=item IO::AIO::poll_cb 1771=item IO::AIO::poll_cb
1669 1772
1670Process some outstanding events on the result pipe. You have to call 1773Process some requests that have reached the result phase (i.e. they have
1774been executed but the results are not yet reported). You have to call
1775this "regularly" to finish outstanding requests.
1776
1671this regularly. Returns C<0> if all events could be processed (or there 1777Returns C<0> if all events could be processed (or there were no
1672were no events to process), or C<-1> if it returned earlier for whatever 1778events to process), or C<-1> if it returned earlier for whatever
1673reason. Returns immediately when no events are outstanding. The amount of 1779reason. Returns immediately when no events are outstanding. The amount
1674events processed depends on the settings of C<IO::AIO::max_poll_req> and 1780of events processed depends on the settings of C<IO::AIO::max_poll_req>,
1675C<IO::AIO::max_poll_time>. 1781C<IO::AIO::max_poll_time> and C<IO::AIO::max_outstanding>.
1676 1782
1677If not all requests were processed for whatever reason, the filehandle 1783If not all requests were processed for whatever reason, the poll file
1678will still be ready when C<poll_cb> returns, so normally you don't have to 1784descriptor will still be ready when C<poll_cb> returns, so normally you
1679do anything special to have it called later. 1785don't have to do anything special to have it called later.
1680 1786
1681Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes 1787Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes
1682ready, it can be beneficial to call this function from loops which submit 1788ready, it can be beneficial to call this function from loops which submit
1683a lot of requests, to make sure the results get processed when they become 1789a lot of requests, to make sure the results get processed when they become
1684available and not just when the loop is finished and the event loop takes 1790available and not just when the loop is finished and the event loop takes
1693 poll => 'r', async => 1, 1799 poll => 'r', async => 1,
1694 cb => \&IO::AIO::poll_cb); 1800 cb => \&IO::AIO::poll_cb);
1695 1801
1696=item IO::AIO::poll_wait 1802=item IO::AIO::poll_wait
1697 1803
1698If there are any outstanding requests and none of them in the result 1804Wait until either at least one request is in the result phase or no
1699phase, wait till the result filehandle becomes ready for reading (simply 1805requests are outstanding anymore.
1700does a C<select> on the filehandle. This is useful if you want to 1806
1701synchronously wait for some requests to finish). 1807This is useful if you want to synchronously wait for some requests to
1808become ready, without actually handling them.
1702 1809
1703See C<nreqs> for an example. 1810See C<nreqs> for an example.
1704 1811
1705=item IO::AIO::poll 1812=item IO::AIO::poll
1706 1813
2009=item IO::AIO::tee $r_fh, $w_fh, $length, $flags 2116=item IO::AIO::tee $r_fh, $w_fh, $length, $flags
2010 2117
2011Calls the GNU/Linux C<tee(2)> syscall, see it's manpage and the 2118Calls the GNU/Linux C<tee(2)> syscall, see it's manpage and the
2012description for C<IO::AIO::splice> above for details. 2119description for C<IO::AIO::splice> above for details.
2013 2120
2121=item $actual_size = IO::AIO::pipesize $r_fh[, $new_size]
2122
2123Attempts to query or change the pipe buffer size. Obviously works only
2124on pipes, and currently works only on GNU/Linux systems, and fails with
2125C<-1>/C<ENOSYS> everywhere else. If anybody knows how to influence pipe buffer
2126size on other systems, drop me a note.
2127
2014=back 2128=back
2015 2129
2016=cut 2130=cut
2017 2131
2018min_parallel 8; 2132min_parallel 8;

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines