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.222 by root, Fri Apr 6 11:39:25 2012 UTC vs.
Revision 1.241 by root, Fri Dec 28 07:33:41 2012 UTC

168use common::sense; 168use common::sense;
169 169
170use base 'Exporter'; 170use base 'Exporter';
171 171
172BEGIN { 172BEGIN {
173 our $VERSION = '4.13'; 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)
272 IO::AIO::nready 274 IO::AIO::nready
273 IO::AIO::npending 275 IO::AIO::npending
274 276
275 IO::AIO::sendfile $ofh, $ifh, $offset, $count 277 IO::AIO::sendfile $ofh, $ifh, $offset, $count
276 IO::AIO::fadvise $fh, $offset, $len, $advice 278 IO::AIO::fadvise $fh, $offset, $len, $advice
279 IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]
280 IO::AIO::munmap $scalar
277 IO::AIO::madvise $scalar, $offset, $length, $advice 281 IO::AIO::madvise $scalar, $offset, $length, $advice
278 IO::AIO::mprotect $scalar, $offset, $length, $protect 282 IO::AIO::mprotect $scalar, $offset, $length, $protect
279 IO::AIO::munlock $scalar, $offset = 0, $length = undef 283 IO::AIO::munlock $scalar, $offset = 0, $length = undef
280 IO::AIO::munlockall 284 IO::AIO::munlockall
281 285
358 362
359 363
360=item aio_open $pathname, $flags, $mode, $callback->($fh) 364=item aio_open $pathname, $flags, $mode, $callback->($fh)
361 365
362Asynchronously 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
363created filehandle for the file. 367created filehandle for the file (or C<undef> in case of an error).
364 368
365The 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,
366for an explanation. 370for an explanation.
367 371
368The 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
424case of an error. 428case of an error.
425 429
426In theory, the C<$whence> constants could be different than the 430In theory, the C<$whence> constants could be different than the
427corresponding values from L<Fcntl>, but perl guarantees they are the same, 431corresponding values from L<Fcntl>, but perl guarantees they are the same,
428so don't panic. 432so don't panic.
433
434As a GNU/Linux (and maybe Solaris) extension, also the constants
435C<IO::AIO::SEEK_DATA> and C<IO::AIO::SEEK_HOLE> are available, if they
436could be found. No guarantees about suitability for use in C<aio_seek> or
437Perl's C<sysseek> can be made though, although I would naively assume they
438"just work".
429 439
430=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 440=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
431 441
432=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 442=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
433 443
593 namemax => 255, 603 namemax => 255,
594 frsize => 1024, 604 frsize => 1024,
595 fsid => 1810 605 fsid => 1810
596 } 606 }
597 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
598 689
599=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 690=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
600 691
601Works 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
602and $mtime being undef). Fractional times are supported if the underlying 693and $mtime being undef). Fractional times are supported if the underlying
630=item aio_truncate $fh_or_path, $offset, $callback->($status) 721=item aio_truncate $fh_or_path, $offset, $callback->($status)
631 722
632Works like truncate(2) or ftruncate(2). 723Works like truncate(2) or ftruncate(2).
633 724
634 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
635=item aio_chmod $fh_or_path, $mode, $callback->($status) 742=item aio_chmod $fh_or_path, $mode, $callback->($status)
636 743
637Works like perl's C<chmod> function. 744Works like perl's C<chmod> function.
638 745
639 746
676 783
677 784
678=item aio_realpath $pathname, $callback->($path) 785=item aio_realpath $pathname, $callback->($path)
679 786
680Asynchronously make the path absolute and resolve any symlinks in 787Asynchronously make the path absolute and resolve any symlinks in
681C<$path>. The resulting path only consists of directories (Same as 788C<$path>. The resulting path only consists of directories (same as
682L<Cwd::realpath>). 789L<Cwd::realpath>).
683 790
684This 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
685directory by passing it a path of F<.> (a single dot). 792directory by passing it a path of F<.> (a single dot).
686 793
687 794
688=item aio_rename $srcpath, $dstpath, $callback->($status) 795=item aio_rename $srcpath, $dstpath, $callback->($status)
689 796
690Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as 797Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
691rename(2) and call the callback with the result code. 798rename(2) and call the callback with the result code.
799
800On systems that support the AIO::WD working directory abstraction
801natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead
802of failing, C<rename> is called on the absolute path of C<$wd>.
692 803
693 804
694=item aio_mkdir $pathname, $mode, $callback->($status) 805=item aio_mkdir $pathname, $mode, $callback->($status)
695 806
696Asynchronously mkdir (create) a directory and call the callback with 807Asynchronously mkdir (create) a directory and call the callback with
700 811
701=item aio_rmdir $pathname, $callback->($status) 812=item aio_rmdir $pathname, $callback->($status)
702 813
703Asynchronously rmdir (delete) a directory and call the callback with the 814Asynchronously rmdir (delete) a directory and call the callback with the
704result code. 815result code.
816
817On systems that support the AIO::WD working directory abstraction
818natively, the case C<[$wd, "."]> is specialcased - instead of failing,
819C<rmdir> is called on the absolute path of C<$wd>.
705 820
706 821
707=item aio_readdir $pathname, $callback->($entries) 822=item aio_readdir $pathname, $callback->($entries)
708 823
709Unlike the POSIX call of the same name, C<aio_readdir> reads an entire 824Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
1074} 1189}
1075 1190
1076=item aio_rmtree $pathname, $callback->($status) 1191=item aio_rmtree $pathname, $callback->($status)
1077 1192
1078Delete a directory tree starting (and including) C<$path>, return the 1193Delete a directory tree starting (and including) C<$path>, return the
1079status of the final C<rmdir> only. This is a composite request that 1194status of the final C<rmdir> only. This is a composite request that
1080uses C<aio_scandir> to recurse into and rmdir directories, and unlink 1195uses C<aio_scandir> to recurse into and rmdir directories, and unlink
1081everything else. 1196everything else.
1082 1197
1083=cut 1198=cut
1084 1199
1204 1319
1205This is a rather advanced IO::AIO call, which works best on mmap(2)ed 1320This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1206scalars. 1321scalars.
1207 1322
1208It touches (reads or writes) all memory pages in the specified 1323It touches (reads or writes) all memory pages in the specified
1209range inside the scalar. All caveats and parameters are the same 1324range inside the scalar. All caveats and parameters are the same
1210as for C<aio_msync>, above, except for flags, which must be either 1325as for C<aio_msync>, above, except for flags, which must be either
1211C<0> (which reads all pages and ensures they are instantiated) or 1326C<0> (which reads all pages and ensures they are instantiated) or
1212C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and 1327C<IO::AIO::MT_MODIFY>, which modifies the memory pages (by reading and
1213writing an octet from it, which dirties the page). 1328writing an octet from it, which dirties the page).
1214 1329
1215=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) 1330=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
1216 1331
1217This is a rather advanced IO::AIO call, which works best on mmap(2)ed 1332This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1248documented under L<MISCELLANEOUS FUNCTIONS>. 1363documented under L<MISCELLANEOUS FUNCTIONS>.
1249 1364
1250Example: asynchronously lock all current and future pages into memory. 1365Example: asynchronously lock all current and future pages into memory.
1251 1366
1252 aio_mlockall IO::AIO::MCL_FUTURE; 1367 aio_mlockall IO::AIO::MCL_FUTURE;
1368
1369=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
1370
1371Queries the extents of the given file (by calling the Linux C<FIEMAP>
1372ioctl, see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If
1373the ioctl is not available on your OS, then this request will fail with
1374C<ENOSYS>.
1375
1376C<$start> is the starting offset to query extents for, C<$length> is the
1377size of the range to query - if it is C<undef>, then the whole file will
1378be queried.
1379
1380C<$flags> is a combination of flags (C<IO::AIO::FIEMAP_FLAG_SYNC> or
1381C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also
1382exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query
1383the data portion.
1384
1385C<$count> is the maximum number of extent records to return. If it is
1386C<undef>, then IO::AIO queries all extents of the range. As a very special
1387case, if it is C<0>, then the callback receives the number of extents
1388instead of the extents themselves (which is unreliable, see below).
1389
1390If an error occurs, the callback receives no arguments. The special
1391C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.
1392
1393Otherwise, the callback receives an array reference with extent
1394structures. Each extent structure is an array reference itself, with the
1395following members:
1396
1397 [$logical, $physical, $length, $flags]
1398
1399Flags is any combination of the following flag values (typically either C<0>
1400or C<IO::AIO::FIEMAP_EXTENT_LAST> (1)):
1401
1402C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,
1403C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,
1404C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,
1405C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,
1406C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or
1407C<IO::AIO::FIEMAP_EXTENT_SHARED>.
1408
1409At the time of this writing (Linux 3.2), this requets is unreliable unless
1410C<$count> is C<undef>, as the kernel has all sorts of bugs preventing
1411it to return all extents of a range for files with large number of
1412extents. The code works around all these issues if C<$count> is undef.
1253 1413
1254=item aio_group $callback->(...) 1414=item aio_group $callback->(...)
1255 1415
1256This is a very special aio request: Instead of doing something, it is a 1416This is a very special aio request: Instead of doing something, it is a
1257container for other aio requests, which is useful if you want to bundle 1417container for other aio requests, which is useful if you want to bundle
1373will still point to the original directory. Most functions accepting a 1533will still point to the original directory. Most functions accepting a
1374pathname will use the directory fd on newer systems, and the string on 1534pathname will use the directory fd on newer systems, and the string on
1375older systems. Some functions (such as realpath) will always rely on the 1535older systems. Some functions (such as realpath) will always rely on the
1376string form of the pathname. 1536string form of the pathname.
1377 1537
1378So this fucntionality is mainly useful to get some protection against 1538So this functionality is mainly useful to get some protection against
1379C<chdir>, to easily get an absolute path out of a relative path for future 1539C<chdir>, to easily get an absolute path out of a relative path for future
1380reference, and to speed up doing many operations in the same directory 1540reference, and to speed up doing many operations in the same directory
1381(e.g. when stat'ing all files in a directory). 1541(e.g. when stat'ing all files in a directory).
1382 1542
1383The following functions implement this working directory abstraction: 1543The following functions implement this working directory abstraction:
1404=item IO::AIO::CWD 1564=item IO::AIO::CWD
1405 1565
1406This is a compiletime constant (object) that represents the process 1566This is a compiletime constant (object) that represents the process
1407current working directory. 1567current working directory.
1408 1568
1409Specifying this object as working directory object for a pathname is as 1569Specifying this object as working directory object for a pathname is as if
1410if the pathname would be specified directly, without a directory object, 1570the pathname would be specified directly, without a directory object. For
1411e.g., these calls are functionally identical: 1571example, these calls are functionally identical:
1412 1572
1413 aio_stat "somefile", sub { ... }; 1573 aio_stat "somefile", sub { ... };
1414 aio_stat [IO::AIO::CWD, "somefile"], sub { ... }; 1574 aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
1415 1575
1416=back 1576=back
1417 1577
1578To recover the path associated with an IO::AIO::WD object, you can use
1579C<aio_realpath>:
1580
1581 aio_realpath $wd, sub {
1582 warn "path is $_[0]\n";
1583 };
1584
1585Currently, C<aio_statvfs> always, and C<aio_rename> and C<aio_rmdir>
1586sometimes, fall back to using an absolue path.
1418 1587
1419=head2 IO::AIO::REQ CLASS 1588=head2 IO::AIO::REQ CLASS
1420 1589
1421All non-aggregate C<aio_*> functions return an object of this class when 1590All non-aggregate C<aio_*> functions return an object of this class when
1422called in non-void context. 1591called in non-void context.
1600 1769
1601See C<poll_cb> for an example. 1770See C<poll_cb> for an example.
1602 1771
1603=item IO::AIO::poll_cb 1772=item IO::AIO::poll_cb
1604 1773
1605Process some outstanding events on the result pipe. You have to call 1774Process some requests that have reached the result phase (i.e. they have
1775been executed but the results are not yet reported). You have to call
1776this "regularly" to finish outstanding requests.
1777
1606this regularly. Returns C<0> if all events could be processed (or there 1778Returns C<0> if all events could be processed (or there were no
1607were no events to process), or C<-1> if it returned earlier for whatever 1779events to process), or C<-1> if it returned earlier for whatever
1608reason. Returns immediately when no events are outstanding. The amount of 1780reason. Returns immediately when no events are outstanding. The amount
1609events processed depends on the settings of C<IO::AIO::max_poll_req> and 1781of events processed depends on the settings of C<IO::AIO::max_poll_req>,
1610C<IO::AIO::max_poll_time>. 1782C<IO::AIO::max_poll_time> and C<IO::AIO::max_outstanding>.
1611 1783
1612If not all requests were processed for whatever reason, the filehandle 1784If not all requests were processed for whatever reason, the poll file
1613will still be ready when C<poll_cb> returns, so normally you don't have to 1785descriptor will still be ready when C<poll_cb> returns, so normally you
1614do anything special to have it called later. 1786don't have to do anything special to have it called later.
1615 1787
1616Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes 1788Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes
1617ready, it can be beneficial to call this function from loops which submit 1789ready, it can be beneficial to call this function from loops which submit
1618a lot of requests, to make sure the results get processed when they become 1790a lot of requests, to make sure the results get processed when they become
1619available and not just when the loop is finished and the event loop takes 1791available and not just when the loop is finished and the event loop takes
1628 poll => 'r', async => 1, 1800 poll => 'r', async => 1,
1629 cb => \&IO::AIO::poll_cb); 1801 cb => \&IO::AIO::poll_cb);
1630 1802
1631=item IO::AIO::poll_wait 1803=item IO::AIO::poll_wait
1632 1804
1633If there are any outstanding requests and none of them in the result 1805Wait until either at least one request is in the result phase or no
1634phase, wait till the result filehandle becomes ready for reading (simply 1806requests are outstanding anymore.
1635does a C<select> on the filehandle. This is useful if you want to 1807
1636synchronously wait for some requests to finish). 1808This is useful if you want to synchronously wait for some requests to
1809become ready, without actually handling them.
1637 1810
1638See C<nreqs> for an example. 1811See C<nreqs> for an example.
1639 1812
1640=item IO::AIO::poll 1813=item IO::AIO::poll
1641 1814
1860ENOSYS, otherwise the return value of C<mprotect>. 2033ENOSYS, otherwise the return value of C<mprotect>.
1861 2034
1862=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] 2035=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
1863 2036
1864Memory-maps a file (or anonymous memory range) and attaches it to the 2037Memory-maps a file (or anonymous memory range) and attaches it to the
1865given C<$scalar>, which will act like a string scalar. 2038given C<$scalar>, which will act like a string scalar. Returns true on
2039success, and false otherwise.
1866 2040
1867The only operations allowed on the scalar are C<substr>/C<vec> that don't 2041The only operations allowed on the scalar are C<substr>/C<vec> that don't
1868change the string length, and most read-only operations such as copying it 2042change the string length, and most read-only operations such as copying it
1869or searching it with regexes and so on. 2043or searching it with regexes and so on.
1870 2044
1923Calls the C<munlockall> function. 2097Calls the C<munlockall> function.
1924 2098
1925On systems that do not implement C<munlockall>, this function returns 2099On systems that do not implement C<munlockall>, this function returns
1926ENOSYS, otherwise the return value of C<munlockall>. 2100ENOSYS, otherwise the return value of C<munlockall>.
1927 2101
2102=item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
2103
2104Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or
2105C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they
2106should be the file offset.
2107
2108C<$r_fh> and C<$w_fh> should not refer to the same file, as splice might
2109silently corrupt the data in this case.
2110
2111The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>,
2112C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and
2113C<IO::AIO::SPLICE_F_GIFT>.
2114
2115See the C<splice(2)> manpage for details.
2116
2117=item IO::AIO::tee $r_fh, $w_fh, $length, $flags
2118
2119Calls the GNU/Linux C<tee(2)> syscall, see it's manpage and the
2120description for C<IO::AIO::splice> above for details.
2121
1928=back 2122=back
1929 2123
1930=cut 2124=cut
1931 2125
1932min_parallel 8; 2126min_parallel 8;

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines