1 | =head1 NAME |
1 | =head1 NAME |
2 | |
2 | |
3 | IO::AIO - Asynchronous Input/Output |
3 | IO::AIO - Asynchronous/Advanced Input/Output |
4 | |
4 | |
5 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
6 | |
6 | |
7 | use IO::AIO; |
7 | use IO::AIO; |
8 | |
8 | |
… | |
… | |
58 | not well-supported or restricted (GNU/Linux doesn't allow them on normal |
58 | not well-supported or restricted (GNU/Linux doesn't allow them on normal |
59 | files currently, for example), and they would only support aio_read and |
59 | files currently, for example), and they would only support aio_read and |
60 | aio_write, so the remaining functionality would have to be implemented |
60 | aio_write, so the remaining functionality would have to be implemented |
61 | using threads anyway. |
61 | using threads anyway. |
62 | |
62 | |
|
|
63 | In addition to asynchronous I/O, this module also exports some rather |
|
|
64 | arcane interfaces, such as C<madvise> or linux's C<splice> system call, |
|
|
65 | which is why the C<A> in C<AIO> can also mean I<advanced>. |
|
|
66 | |
63 | Although the module will work in the presence of other (Perl-) threads, |
67 | Although the module will work in the presence of other (Perl-) threads, |
64 | it is currently not reentrant in any way, so use appropriate locking |
68 | it is currently not reentrant in any way, so use appropriate locking |
65 | yourself, always call C<poll_cb> from within the same thread, or never |
69 | yourself, always call C<poll_cb> from within the same thread, or never |
66 | call C<poll_cb> (or other C<aio_> functions) recursively. |
70 | call C<poll_cb> (or other C<aio_> functions) recursively. |
67 | |
71 | |
… | |
… | |
167 | use common::sense; |
171 | use common::sense; |
168 | |
172 | |
169 | use base 'Exporter'; |
173 | use base 'Exporter'; |
170 | |
174 | |
171 | BEGIN { |
175 | BEGIN { |
172 | our $VERSION = 4.33; |
176 | our $VERSION = 4.4; |
173 | |
177 | |
174 | our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close |
178 | our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close |
175 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx |
179 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx |
176 | aio_scandir aio_symlink aio_readlink aio_realpath aio_sync |
180 | aio_scandir aio_symlink aio_readlink aio_realpath aio_fcntl aio_ioctl |
177 | aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_allocate |
181 | aio_sync aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range |
178 | aio_pathsync aio_readahead aio_fiemap |
182 | aio_pathsync aio_readahead aio_fiemap aio_allocate |
179 | aio_rename aio_link aio_move aio_copy aio_group |
183 | aio_rename aio_rename2 aio_link aio_move aio_copy aio_group |
180 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
184 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
181 | aio_chmod aio_utime aio_truncate |
185 | aio_chmod aio_utime aio_truncate |
182 | aio_msync aio_mtouch aio_mlock aio_mlockall |
186 | aio_msync aio_mtouch aio_mlock aio_mlockall |
183 | aio_statvfs |
187 | aio_statvfs |
|
|
188 | aio_slurp |
184 | aio_wd); |
189 | aio_wd); |
185 | |
190 | |
186 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
191 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
187 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
192 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
188 | min_parallel max_parallel max_idle idle_timeout |
193 | min_parallel max_parallel max_idle idle_timeout |
… | |
… | |
229 | aio_link $srcpath, $dstpath, $callback->($status) |
234 | aio_link $srcpath, $dstpath, $callback->($status) |
230 | aio_symlink $srcpath, $dstpath, $callback->($status) |
235 | aio_symlink $srcpath, $dstpath, $callback->($status) |
231 | aio_readlink $pathname, $callback->($link) |
236 | aio_readlink $pathname, $callback->($link) |
232 | aio_realpath $pathname, $callback->($path) |
237 | aio_realpath $pathname, $callback->($path) |
233 | aio_rename $srcpath, $dstpath, $callback->($status) |
238 | aio_rename $srcpath, $dstpath, $callback->($status) |
|
|
239 | aio_rename2 $srcpath, $dstpath, $flags, $callback->($status) |
234 | aio_mkdir $pathname, $mode, $callback->($status) |
240 | aio_mkdir $pathname, $mode, $callback->($status) |
235 | aio_rmdir $pathname, $callback->($status) |
241 | aio_rmdir $pathname, $callback->($status) |
236 | aio_readdir $pathname, $callback->($entries) |
242 | aio_readdir $pathname, $callback->($entries) |
237 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
243 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
238 | IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST |
244 | IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST |
… | |
… | |
240 | aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs) |
246 | aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs) |
241 | aio_load $pathname, $data, $callback->($status) |
247 | aio_load $pathname, $data, $callback->($status) |
242 | aio_copy $srcpath, $dstpath, $callback->($status) |
248 | aio_copy $srcpath, $dstpath, $callback->($status) |
243 | aio_move $srcpath, $dstpath, $callback->($status) |
249 | aio_move $srcpath, $dstpath, $callback->($status) |
244 | aio_rmtree $pathname, $callback->($status) |
250 | aio_rmtree $pathname, $callback->($status) |
|
|
251 | aio_fcntl $fh, $cmd, $arg, $callback->($status) |
|
|
252 | aio_ioctl $fh, $request, $buf, $callback->($status) |
245 | aio_sync $callback->($status) |
253 | aio_sync $callback->($status) |
246 | aio_syncfs $fh, $callback->($status) |
254 | aio_syncfs $fh, $callback->($status) |
247 | aio_fsync $fh, $callback->($status) |
255 | aio_fsync $fh, $callback->($status) |
248 | aio_fdatasync $fh, $callback->($status) |
256 | aio_fdatasync $fh, $callback->($status) |
249 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
257 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
250 | aio_pathsync $pathname, $callback->($status) |
258 | aio_pathsync $pathname, $callback->($status) |
251 | aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
259 | aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status) |
252 | aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
260 | aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
253 | aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
261 | aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
254 | aio_mlockall $flags, $callback->($status) |
262 | aio_mlockall $flags, $callback->($status) |
255 | aio_group $callback->(...) |
263 | aio_group $callback->(...) |
256 | aio_nop $callback->() |
264 | aio_nop $callback->() |
… | |
… | |
270 | IO::AIO::idle_timeout $seconds |
278 | IO::AIO::idle_timeout $seconds |
271 | IO::AIO::max_outstanding $maxreqs |
279 | IO::AIO::max_outstanding $maxreqs |
272 | IO::AIO::nreqs |
280 | IO::AIO::nreqs |
273 | IO::AIO::nready |
281 | IO::AIO::nready |
274 | IO::AIO::npending |
282 | IO::AIO::npending |
|
|
283 | $nfd = IO::AIO::get_fdlimit [EXPERIMENTAL] |
|
|
284 | IO::AIO::min_fdlimit $nfd [EXPERIMENTAL] |
275 | |
285 | |
276 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
286 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
277 | IO::AIO::fadvise $fh, $offset, $len, $advice |
287 | IO::AIO::fadvise $fh, $offset, $len, $advice |
278 | IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]] |
288 | IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]] |
279 | IO::AIO::munmap $scalar |
289 | IO::AIO::munmap $scalar |
… | |
… | |
439 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
449 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
440 | |
450 | |
441 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
451 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
442 | |
452 | |
443 | Reads or writes C<$length> bytes from or to the specified C<$fh> and |
453 | Reads or writes C<$length> bytes from or to the specified C<$fh> and |
444 | C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> |
454 | C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> and |
445 | and calls the callback without the actual number of bytes read (or -1 on |
455 | calls the callback with the actual number of bytes transferred (or -1 on |
446 | error, just like the syscall). |
456 | error, just like the syscall). |
447 | |
457 | |
448 | C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to |
458 | C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to |
449 | offset plus the actual number of bytes read. |
459 | offset plus the actual number of bytes read. |
450 | |
460 | |
… | |
… | |
508 | As native sendfile syscalls (as practically any non-POSIX interface hacked |
518 | As native sendfile syscalls (as practically any non-POSIX interface hacked |
509 | together in a hurry to improve benchmark numbers) tend to be rather buggy |
519 | together in a hurry to improve benchmark numbers) tend to be rather buggy |
510 | on many systems, this implementation tries to work around some known bugs |
520 | on many systems, this implementation tries to work around some known bugs |
511 | in Linux and FreeBSD kernels (probably others, too), but that might fail, |
521 | in Linux and FreeBSD kernels (probably others, too), but that might fail, |
512 | so you really really should check the return value of C<aio_sendfile> - |
522 | so you really really should check the return value of C<aio_sendfile> - |
513 | fewre bytes than expected might have been transferred. |
523 | fewer bytes than expected might have been transferred. |
514 | |
524 | |
515 | |
525 | |
516 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
526 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
517 | |
527 | |
518 | C<aio_readahead> populates the page cache with data from a file so that |
528 | C<aio_readahead> populates the page cache with data from a file so that |
… | |
… | |
522 | whole pages, so that offset is effectively rounded down to a page boundary |
532 | whole pages, so that offset is effectively rounded down to a page boundary |
523 | and bytes are read up to the next page boundary greater than or equal to |
533 | and bytes are read up to the next page boundary greater than or equal to |
524 | (off-set+length). C<aio_readahead> does not read beyond the end of the |
534 | (off-set+length). C<aio_readahead> does not read beyond the end of the |
525 | file. The current file offset of the file is left unchanged. |
535 | file. The current file offset of the file is left unchanged. |
526 | |
536 | |
527 | If that syscall doesn't exist (likely if your OS isn't Linux) it will be |
537 | If that syscall doesn't exist (likely if your kernel isn't Linux) it will |
528 | emulated by simply reading the data, which would have a similar effect. |
538 | be emulated by simply reading the data, which would have a similar effect. |
529 | |
539 | |
530 | |
540 | |
531 | =item aio_stat $fh_or_path, $callback->($status) |
541 | =item aio_stat $fh_or_path, $callback->($status) |
532 | |
542 | |
533 | =item aio_lstat $fh, $callback->($status) |
543 | =item aio_lstat $fh, $callback->($status) |
… | |
… | |
602 | namemax => 255, |
612 | namemax => 255, |
603 | frsize => 1024, |
613 | frsize => 1024, |
604 | fsid => 1810 |
614 | fsid => 1810 |
605 | } |
615 | } |
606 | |
616 | |
607 | Here is a (likely partial - send me updates!) list of fsid values used by |
|
|
608 | Linux - it is safe to hardcode these when C<$^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/ext4 |
|
|
632 | 0x0000ef51 ext2 |
|
|
633 | 0xf2f52010 f2fs |
|
|
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 | 0x00c0ffee hostfs |
|
|
643 | 0x958458f6 hugetlbfs |
|
|
644 | 0x2bad1dea inotifyfs |
|
|
645 | 0x00009660 isofs |
|
|
646 | 0x000072b6 jffs2 |
|
|
647 | 0x3153464a jfs |
|
|
648 | 0x6b414653 k-afs |
|
|
649 | 0x0bd00bd0 lustre |
|
|
650 | 0x0000137f minix |
|
|
651 | 0x0000138f minix 30 char names |
|
|
652 | 0x00002468 minix v2 |
|
|
653 | 0x00002478 minix v2 30 char names |
|
|
654 | 0x00004d5a minix v3 |
|
|
655 | 0x19800202 mqueue |
|
|
656 | 0x00004d44 msdos |
|
|
657 | 0x0000564c novell |
|
|
658 | 0x00006969 nfs |
|
|
659 | 0x6e667364 nfsd |
|
|
660 | 0x00003434 nilfs |
|
|
661 | 0x5346544e ntfs |
|
|
662 | 0x00009fa1 openprom |
|
|
663 | 0x7461636F ocfs2 |
|
|
664 | 0x00009fa0 proc |
|
|
665 | 0x6165676c pstorefs |
|
|
666 | 0x0000002f qnx4 |
|
|
667 | 0x68191122 qnx6 |
|
|
668 | 0x858458f6 ramfs |
|
|
669 | 0x52654973 reiserfs |
|
|
670 | 0x00007275 romfs |
|
|
671 | 0x67596969 rpc_pipefs |
|
|
672 | 0x73636673 securityfs |
|
|
673 | 0xf97cff8c selinux |
|
|
674 | 0x0000517b smb |
|
|
675 | 0x534f434b sockfs |
|
|
676 | 0x73717368 squashfs |
|
|
677 | 0x62656572 sysfs |
|
|
678 | 0x012ff7b6 sysv2 |
|
|
679 | 0x012ff7b5 sysv4 |
|
|
680 | 0x01021994 tmpfs |
|
|
681 | 0x15013346 udf |
|
|
682 | 0x00011954 ufs |
|
|
683 | 0x54190100 ufs byteswapped |
|
|
684 | 0x00009fa2 usbdevfs |
|
|
685 | 0x01021997 v9fs |
|
|
686 | 0xa501fcf5 vxfs |
|
|
687 | 0xabba1974 xenfs |
|
|
688 | 0x012ff7b4 xenix |
|
|
689 | 0x58465342 xfs |
|
|
690 | 0x012fd16d xia |
|
|
691 | |
|
|
692 | =item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
617 | =item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
693 | |
618 | |
694 | Works like perl's C<utime> function (including the special case of $atime |
619 | Works like perl's C<utime> function (including the special case of $atime |
695 | and $mtime being undef). Fractional times are supported if the underlying |
620 | and $mtime being undef). Fractional times are supported if the underlying |
696 | syscalls support them. |
621 | syscalls support them. |
… | |
… | |
733 | C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate |
658 | C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate |
734 | space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE | IO::AIO::FALLOC_FL_KEEP_SIZE>, |
659 | space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE | IO::AIO::FALLOC_FL_KEEP_SIZE>, |
735 | to deallocate a file range. |
660 | to deallocate a file range. |
736 | |
661 | |
737 | IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range |
662 | IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range |
738 | (without leaving a hole) and C<FALLOC_FL_ZERO_RANGE>, to zero a range (see |
663 | (without leaving a hole), C<FALLOC_FL_ZERO_RANGE>, to zero a range, |
739 | your L<fallocate(2)> manpage). |
664 | C<FALLOC_FL_INSERT_RANGE> to insert a range and C<FALLOC_FL_UNSHARE_RANGE> |
|
|
665 | to unshare shared blocks (see your L<fallocate(2)> manpage). |
740 | |
666 | |
741 | The file system block size used by C<fallocate> is presumably the |
667 | The file system block size used by C<fallocate> is presumably the |
742 | C<f_bsize> returned by C<statvfs>. |
668 | C<f_bsize> returned by C<statvfs>, but different filesystems and filetypes |
|
|
669 | can dictate other limitations. |
743 | |
670 | |
744 | If C<fallocate> isn't available or cannot be emulated (currently no |
671 | If C<fallocate> isn't available or cannot be emulated (currently no |
745 | emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>. |
672 | emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>. |
746 | |
673 | |
747 | |
674 | |
… | |
… | |
806 | On systems that support the AIO::WD working directory abstraction |
733 | On systems that support the AIO::WD working directory abstraction |
807 | natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead |
734 | natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead |
808 | of failing, C<rename> is called on the absolute path of C<$wd>. |
735 | of failing, C<rename> is called on the absolute path of C<$wd>. |
809 | |
736 | |
810 | |
737 | |
|
|
738 | =item aio_rename2 $srcpath, $dstpath, $flags, $callback->($status) |
|
|
739 | |
|
|
740 | Basically a version of C<aio_rename> with an additional C<$flags> |
|
|
741 | argument. Calling this with C<$flags=0> is the same as calling |
|
|
742 | C<aio_rename>. |
|
|
743 | |
|
|
744 | Non-zero flags are currently only supported on GNU/Linux systems that |
|
|
745 | support renameat2. Other systems fail with C<ENOSYS> in this case. |
|
|
746 | |
|
|
747 | The following constants are available (missing ones are, as usual C<0>), |
|
|
748 | see renameat2(2) for details: |
|
|
749 | |
|
|
750 | C<IO::AIO::RENAME_NOREPLACE>, C<IO::AIO::RENAME_EXCHANGE> |
|
|
751 | and C<IO::AIO::RENAME_WHITEOUT>. |
|
|
752 | |
|
|
753 | |
811 | =item aio_mkdir $pathname, $mode, $callback->($status) |
754 | =item aio_mkdir $pathname, $mode, $callback->($status) |
812 | |
755 | |
813 | Asynchronously mkdir (create) a directory and call the callback with |
756 | Asynchronously mkdir (create) a directory and call the callback with |
814 | the result code. C<$mode> will be modified by the umask at the time the |
757 | the result code. C<$mode> will be modified by the umask at the time the |
815 | request is executed, so do not change your umask. |
758 | request is executed, so do not change your umask. |
… | |
… | |
846 | |
789 | |
847 | =over 4 |
790 | =over 4 |
848 | |
791 | |
849 | =item IO::AIO::READDIR_DENTS |
792 | =item IO::AIO::READDIR_DENTS |
850 | |
793 | |
851 | When this flag is off, then the callback gets an arrayref consisting of |
794 | Normally the callback gets an arrayref consisting of names only (as |
852 | names only (as with C<aio_readdir>), otherwise it gets an arrayref with |
795 | with C<aio_readdir>). If this flag is set, then the callback gets an |
853 | C<[$name, $type, $inode]> arrayrefs, each describing a single directory |
796 | arrayref with C<[$name, $type, $inode]> arrayrefs, each describing a |
854 | entry in more detail. |
797 | single directory entry in more detail: |
855 | |
798 | |
856 | C<$name> is the name of the entry. |
799 | C<$name> is the name of the entry. |
857 | |
800 | |
858 | C<$type> is one of the C<IO::AIO::DT_xxx> constants: |
801 | C<$type> is one of the C<IO::AIO::DT_xxx> constants: |
859 | |
802 | |
860 | C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>, |
803 | C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>, |
861 | C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>, |
804 | C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>, |
862 | C<IO::AIO::DT_WHT>. |
805 | C<IO::AIO::DT_WHT>. |
863 | |
806 | |
864 | C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to |
807 | C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need |
865 | know, you have to run stat yourself. Also, for speed reasons, the C<$type> |
808 | to know, you have to run stat yourself. Also, for speed/memory reasons, |
866 | scalars are read-only: you can not modify them. |
809 | the C<$type> scalars are read-only: you must not modify them. |
867 | |
810 | |
868 | C<$inode> is the inode number (which might not be exact on systems with 64 |
811 | C<$inode> is the inode number (which might not be exact on systems with 64 |
869 | bit inode numbers and 32 bit perls). This field has unspecified content on |
812 | bit inode numbers and 32 bit perls). This field has unspecified content on |
870 | systems that do not deliver the inode information. |
813 | systems that do not deliver the inode information. |
871 | |
814 | |
… | |
… | |
882 | short names are tried first. |
825 | short names are tried first. |
883 | |
826 | |
884 | =item IO::AIO::READDIR_STAT_ORDER |
827 | =item IO::AIO::READDIR_STAT_ORDER |
885 | |
828 | |
886 | When this flag is set, then the names will be returned in an order |
829 | When this flag is set, then the names will be returned in an order |
887 | suitable for stat()'ing each one. That is, when you plan to stat() |
830 | suitable for stat()'ing each one. That is, when you plan to stat() most or |
888 | all files in the given directory, then the returned order will likely |
831 | all files in the given directory, then the returned order will likely be |
889 | be fastest. |
832 | faster. |
890 | |
833 | |
891 | If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, then |
834 | If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, |
892 | the likely dirs come first, resulting in a less optimal stat order. |
835 | then the likely dirs come first, resulting in a less optimal stat order |
|
|
836 | for stat'ing all entries, but likely a more optimal order for finding |
|
|
837 | subdirectories. |
893 | |
838 | |
894 | =item IO::AIO::READDIR_FOUND_UNKNOWN |
839 | =item IO::AIO::READDIR_FOUND_UNKNOWN |
895 | |
840 | |
896 | This flag should not be set when calling C<aio_readdirx>. Instead, it |
841 | This flag should not be set when calling C<aio_readdirx>. Instead, it |
897 | is being set by C<aio_readdirx>, when any of the C<$type>'s found were |
842 | is being set by C<aio_readdirx>, when any of the C<$type>'s found were |
… | |
… | |
899 | C<$type>'s are known, which can be used to speed up some algorithms. |
844 | C<$type>'s are known, which can be used to speed up some algorithms. |
900 | |
845 | |
901 | =back |
846 | =back |
902 | |
847 | |
903 | |
848 | |
|
|
849 | =item aio_slurp $pathname, $offset, $length, $data, $callback->($status) |
|
|
850 | |
|
|
851 | Opens, reads and closes the given file. The data is put into C<$data>, |
|
|
852 | which is resized as required. |
|
|
853 | |
|
|
854 | If C<$offset> is negative, then it is counted from the end of the file. |
|
|
855 | |
|
|
856 | If C<$length> is zero, then the remaining length of the file is |
|
|
857 | used. Also, in this case, the same limitations to modifying C<$data> apply |
|
|
858 | as when IO::AIO::mmap is used, i.e. it must only be modified in-place |
|
|
859 | with C<substr>. If the size of the file is known, specifying a non-zero |
|
|
860 | C<$length> results in a performance advantage. |
|
|
861 | |
|
|
862 | This request is similar to the older C<aio_load> request, but since it is |
|
|
863 | a single request, it might be more efficient to use. |
|
|
864 | |
|
|
865 | Example: load F</etc/passwd> into C<$passwd>. |
|
|
866 | |
|
|
867 | my $passwd; |
|
|
868 | aio_slurp "/etc/passwd", 0, 0, $passwd, sub { |
|
|
869 | $_[0] >= 0 |
|
|
870 | or die "/etc/passwd: $!\n"; |
|
|
871 | |
|
|
872 | printf "/etc/passwd is %d bytes long, and contains:\n", length $passwd; |
|
|
873 | print $passwd; |
|
|
874 | }; |
|
|
875 | IO::AIO::flush; |
|
|
876 | |
|
|
877 | |
904 | =item aio_load $pathname, $data, $callback->($status) |
878 | =item aio_load $pathname, $data, $callback->($status) |
905 | |
879 | |
906 | This is a composite request that tries to fully load the given file into |
880 | This is a composite request that tries to fully load the given file into |
907 | memory. Status is the same as with aio_read. |
881 | memory. Status is the same as with aio_read. |
|
|
882 | |
|
|
883 | Using C<aio_slurp> might be more efficient, as it is a single request. |
908 | |
884 | |
909 | =cut |
885 | =cut |
910 | |
886 | |
911 | sub aio_load($$;$) { |
887 | sub aio_load($$;$) { |
912 | my ($path, undef, $cb) = @_; |
888 | my ($path, undef, $cb) = @_; |
… | |
… | |
932 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
908 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
933 | |
909 | |
934 | Try to copy the I<file> (directories not supported as either source or |
910 | Try to copy the I<file> (directories not supported as either source or |
935 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
911 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
936 | a status of C<0> (ok) or C<-1> (error, see C<$!>). |
912 | a status of C<0> (ok) or C<-1> (error, see C<$!>). |
|
|
913 | |
|
|
914 | Existing destination files will be truncated. |
937 | |
915 | |
938 | This is a composite request that creates the destination file with |
916 | This is a composite request that creates the destination file with |
939 | mode 0200 and copies the contents of the source file into it using |
917 | mode 0200 and copies the contents of the source file into it using |
940 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
918 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
941 | uid/gid, in that order. |
919 | uid/gid, in that order. |
… | |
… | |
1051 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
1029 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
1052 | efficiently separate the entries of directory C<$path> into two sets of |
1030 | efficiently separate the entries of directory C<$path> into two sets of |
1053 | names, directories you can recurse into (directories), and ones you cannot |
1031 | names, directories you can recurse into (directories), and ones you cannot |
1054 | recurse into (everything else, including symlinks to directories). |
1032 | recurse into (everything else, including symlinks to directories). |
1055 | |
1033 | |
1056 | C<aio_scandir> is a composite request that creates of many sub requests_ |
1034 | C<aio_scandir> is a composite request that generates many sub requests. |
1057 | C<$maxreq> specifies the maximum number of outstanding aio requests that |
1035 | C<$maxreq> specifies the maximum number of outstanding aio requests that |
1058 | this function generates. If it is C<< <= 0 >>, then a suitable default |
1036 | this function generates. If it is C<< <= 0 >>, then a suitable default |
1059 | will be chosen (currently 4). |
1037 | will be chosen (currently 4). |
1060 | |
1038 | |
1061 | On error, the callback is called without arguments, otherwise it receives |
1039 | On error, the callback is called without arguments, otherwise it receives |
… | |
… | |
1227 | }; |
1205 | }; |
1228 | |
1206 | |
1229 | $grp |
1207 | $grp |
1230 | } |
1208 | } |
1231 | |
1209 | |
|
|
1210 | =item aio_fcntl $fh, $cmd, $arg, $callback->($status) |
|
|
1211 | |
|
|
1212 | =item aio_ioctl $fh, $request, $buf, $callback->($status) |
|
|
1213 | |
|
|
1214 | These work just like the C<fcntl> and C<ioctl> built-in functions, except |
|
|
1215 | they execute asynchronously and pass the return value to the callback. |
|
|
1216 | |
|
|
1217 | Both calls can be used for a lot of things, some of which make more sense |
|
|
1218 | to run asynchronously in their own thread, while some others make less |
|
|
1219 | sense. For example, calls that block waiting for external events, such |
|
|
1220 | as locking, will also lock down an I/O thread while it is waiting, which |
|
|
1221 | can deadlock the whole I/O system. At the same time, there might be no |
|
|
1222 | alternative to using a thread to wait. |
|
|
1223 | |
|
|
1224 | So in general, you should only use these calls for things that do |
|
|
1225 | (filesystem) I/O, not for things that wait for other events (network, |
|
|
1226 | other processes), although if you are careful and know what you are doing, |
|
|
1227 | you still can. |
|
|
1228 | |
|
|
1229 | The following constants are available (missing ones are, as usual C<0>): |
|
|
1230 | |
|
|
1231 | C<F_DUPFD_CLOEXEC>, |
|
|
1232 | |
|
|
1233 | C<F_OFD_GETLK>, C<F_OFD_SETLK>, C<F_OFD_GETLKW>, |
|
|
1234 | |
|
|
1235 | C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>. |
|
|
1236 | |
|
|
1237 | C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>, |
|
|
1238 | C<FS_IOC_FIEMAP>. |
|
|
1239 | |
|
|
1240 | C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>, |
|
|
1241 | C<FS_IOC_GET_ENCRYPTION_PWSALT>, C<FS_IOC_GET_ENCRYPTION_POLICY>, C<FS_KEY_DESCRIPTOR_SIZE>. |
|
|
1242 | |
|
|
1243 | C<FS_SECRM_FL>, C<FS_UNRM_FL>, C<FS_COMPR_FL>, C<FS_SYNC_FL>, C<FS_IMMUTABLE_FL>, |
|
|
1244 | C<FS_APPEND_FL>, C<FS_NODUMP_FL>, C<FS_NOATIME_FL>, C<FS_DIRTY_FL>, |
|
|
1245 | C<FS_COMPRBLK_FL>, C<FS_NOCOMP_FL>, C<FS_ENCRYPT_FL>, C<FS_BTREE_FL>, |
|
|
1246 | C<FS_INDEX_FL>, C<FS_JOURNAL_DATA_FL>, C<FS_NOTAIL_FL>, C<FS_DIRSYNC_FL>, C<FS_TOPDIR_FL>, |
|
|
1247 | C<FS_FL_USER_MODIFIABLE>. |
|
|
1248 | |
|
|
1249 | C<FS_XFLAG_REALTIME>, C<FS_XFLAG_PREALLOC>, C<FS_XFLAG_IMMUTABLE>, C<FS_XFLAG_APPEND>, |
|
|
1250 | C<FS_XFLAG_SYNC>, C<FS_XFLAG_NOATIME>, C<FS_XFLAG_NODUMP>, C<FS_XFLAG_RTINHERIT>, |
|
|
1251 | C<FS_XFLAG_PROJINHERIT>, C<FS_XFLAG_NOSYMLINKS>, C<FS_XFLAG_EXTSIZE>, C<FS_XFLAG_EXTSZINHERIT>, |
|
|
1252 | C<FS_XFLAG_NODEFRAG>, C<FS_XFLAG_FILESTREAM>, C<FS_XFLAG_DAX>, C<FS_XFLAG_HASATTR>, |
|
|
1253 | |
1232 | =item aio_sync $callback->($status) |
1254 | =item aio_sync $callback->($status) |
1233 | |
1255 | |
1234 | Asynchronously call sync and call the callback when finished. |
1256 | Asynchronously call sync and call the callback when finished. |
1235 | |
1257 | |
1236 | =item aio_fsync $fh, $callback->($status) |
1258 | =item aio_fsync $fh, $callback->($status) |
… | |
… | |
1304 | }; |
1326 | }; |
1305 | |
1327 | |
1306 | $grp |
1328 | $grp |
1307 | } |
1329 | } |
1308 | |
1330 | |
1309 | =item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
1331 | =item aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status) |
1310 | |
1332 | |
1311 | This is a rather advanced IO::AIO call, which only works on mmap(2)ed |
1333 | This is a rather advanced IO::AIO call, which only works on mmap(2)ed |
1312 | scalars (see the C<IO::AIO::mmap> function, although it also works on data |
1334 | scalars (see the C<IO::AIO::mmap> function, although it also works on data |
1313 | scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the |
1335 | scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the |
1314 | scalar must only be modified in-place while an aio operation is pending on |
1336 | scalar must only be modified in-place while an aio operation is pending on |
… | |
… | |
1316 | |
1338 | |
1317 | It calls the C<msync> function of your OS, if available, with the memory |
1339 | It calls the C<msync> function of your OS, if available, with the memory |
1318 | area starting at C<$offset> in the string and ending C<$length> bytes |
1340 | area starting at C<$offset> in the string and ending C<$length> bytes |
1319 | later. If C<$length> is negative, counts from the end, and if C<$length> |
1341 | later. If C<$length> is negative, counts from the end, and if C<$length> |
1320 | is C<undef>, then it goes till the end of the string. The flags can be |
1342 | is C<undef>, then it goes till the end of the string. The flags can be |
1321 | a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and |
1343 | either C<IO::AIO::MS_ASYNC> or C<IO::AIO::MS_SYNC>, plus an optional |
1322 | C<IO::AIO::MS_SYNC>. |
1344 | C<IO::AIO::MS_INVALIDATE>. |
1323 | |
1345 | |
1324 | =item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
1346 | =item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
1325 | |
1347 | |
1326 | This is a rather advanced IO::AIO call, which works best on mmap(2)ed |
1348 | This is a rather advanced IO::AIO call, which works best on mmap(2)ed |
1327 | scalars. |
1349 | scalars. |
… | |
… | |
1410 | C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>, |
1432 | C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>, |
1411 | C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>, |
1433 | C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>, |
1412 | C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or |
1434 | C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or |
1413 | C<IO::AIO::FIEMAP_EXTENT_SHARED>. |
1435 | C<IO::AIO::FIEMAP_EXTENT_SHARED>. |
1414 | |
1436 | |
1415 | At the time of this writing (Linux 3.2), this requets is unreliable unless |
1437 | At the time of this writing (Linux 3.2), this request is unreliable unless |
1416 | C<$count> is C<undef>, as the kernel has all sorts of bugs preventing |
1438 | C<$count> is C<undef>, as the kernel has all sorts of bugs preventing |
1417 | it to return all extents of a range for files with large number of |
1439 | it to return all extents of a range for files with a large number of |
1418 | extents. The code works around all these issues if C<$count> is undef. |
1440 | extents. The code (only) works around all these issues if C<$count> is |
|
|
1441 | C<undef>. |
1419 | |
1442 | |
1420 | =item aio_group $callback->(...) |
1443 | =item aio_group $callback->(...) |
1421 | |
1444 | |
1422 | This is a very special aio request: Instead of doing something, it is a |
1445 | This is a very special aio request: Instead of doing something, it is a |
1423 | container for other aio requests, which is useful if you want to bundle |
1446 | container for other aio requests, which is useful if you want to bundle |
… | |
… | |
1536 | There are some caveats: when directories get renamed (or deleted), the |
1559 | There are some caveats: when directories get renamed (or deleted), the |
1537 | pathname string doesn't change, so will point to the new directory (or |
1560 | pathname string doesn't change, so will point to the new directory (or |
1538 | nowhere at all), while the directory fd, if available on the system, |
1561 | nowhere at all), while the directory fd, if available on the system, |
1539 | will still point to the original directory. Most functions accepting a |
1562 | will still point to the original directory. Most functions accepting a |
1540 | pathname will use the directory fd on newer systems, and the string on |
1563 | pathname will use the directory fd on newer systems, and the string on |
1541 | older systems. Some functions (such as realpath) will always rely on the |
1564 | older systems. Some functions (such as C<aio_realpath>) will always rely on |
1542 | string form of the pathname. |
1565 | the string form of the pathname. |
1543 | |
1566 | |
1544 | So this functionality is mainly useful to get some protection against |
1567 | So this functionality is mainly useful to get some protection against |
1545 | C<chdir>, to easily get an absolute path out of a relative path for future |
1568 | C<chdir>, to easily get an absolute path out of a relative path for future |
1546 | reference, and to speed up doing many operations in the same directory |
1569 | reference, and to speed up doing many operations in the same directory |
1547 | (e.g. when stat'ing all files in a directory). |
1570 | (e.g. when stat'ing all files in a directory). |
… | |
… | |
1939 | This is a very bad function to use in interactive programs because it |
1962 | This is a very bad function to use in interactive programs because it |
1940 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1963 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1941 | use an C<aio_group> together with a feed callback. |
1964 | use an C<aio_group> together with a feed callback. |
1942 | |
1965 | |
1943 | Its main use is in scripts without an event loop - when you want to stat |
1966 | Its main use is in scripts without an event loop - when you want to stat |
1944 | a lot of files, you can write somehting like this: |
1967 | a lot of files, you can write something like this: |
1945 | |
1968 | |
1946 | IO::AIO::max_outstanding 32; |
1969 | IO::AIO::max_outstanding 32; |
1947 | |
1970 | |
1948 | for my $path (...) { |
1971 | for my $path (...) { |
1949 | aio_stat $path , ...; |
1972 | aio_stat $path , ...; |
… | |
… | |
1994 | some "Advanced I/O" function not available to in Perl, without going the |
2017 | some "Advanced I/O" function not available to in Perl, without going the |
1995 | "Asynchronous I/O" route. Many of these have an asynchronous C<aio_*> |
2018 | "Asynchronous I/O" route. Many of these have an asynchronous C<aio_*> |
1996 | counterpart. |
2019 | counterpart. |
1997 | |
2020 | |
1998 | =over 4 |
2021 | =over 4 |
|
|
2022 | |
|
|
2023 | =item $numfd = IO::AIO::get_fdlimit |
|
|
2024 | |
|
|
2025 | This function is I<EXPERIMENTAL> and subject to change. |
|
|
2026 | |
|
|
2027 | Tries to find the current file descriptor limit and returns it, or |
|
|
2028 | C<undef> and sets C<$!> in case of an error. The limit is one larger than |
|
|
2029 | the highest valid file descriptor number. |
|
|
2030 | |
|
|
2031 | =item IO::AIO::min_fdlimit [$numfd] |
|
|
2032 | |
|
|
2033 | This function is I<EXPERIMENTAL> and subject to change. |
|
|
2034 | |
|
|
2035 | Try to increase the current file descriptor limit(s) to at least C<$numfd> |
|
|
2036 | by changing the soft or hard file descriptor resource limit. If C<$numfd> |
|
|
2037 | is missing, it will try to set a very high limit, although this is not |
|
|
2038 | recommended when you know the actual minimum that you require. |
|
|
2039 | |
|
|
2040 | If the limit cannot be raised enough, the function makes a best-effort |
|
|
2041 | attempt to increase the limit as much as possible, using various |
|
|
2042 | tricks, while still failing. You can query the resulting limit using |
|
|
2043 | C<IO::AIO::get_fdlimit>. |
|
|
2044 | |
|
|
2045 | If an error occurs, returns C<undef> and sets C<$!>, otherwise returns |
|
|
2046 | true. |
1999 | |
2047 | |
2000 | =item IO::AIO::sendfile $ofh, $ifh, $offset, $count |
2048 | =item IO::AIO::sendfile $ofh, $ifh, $offset, $count |
2001 | |
2049 | |
2002 | Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>, |
2050 | Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>, |
2003 | but is blocking (this makes most sense if you know the input data is |
2051 | but is blocking (this makes most sense if you know the input data is |
… | |
… | |
2020 | =item IO::AIO::madvise $scalar, $offset, $len, $advice |
2068 | =item IO::AIO::madvise $scalar, $offset, $len, $advice |
2021 | |
2069 | |
2022 | Simply calls the C<posix_madvise> function (see its |
2070 | Simply calls the C<posix_madvise> function (see its |
2023 | manpage for details). The following advice constants are |
2071 | manpage for details). The following advice constants are |
2024 | available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, |
2072 | available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, |
2025 | C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>. |
2073 | C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, |
|
|
2074 | C<IO::AIO::MADV_DONTNEED>. |
|
|
2075 | |
|
|
2076 | If C<$offset> is negative, counts from the end. If C<$length> is negative, |
|
|
2077 | the remaining length of the C<$scalar> is used. If possible, C<$length> |
|
|
2078 | will be reduced to fit into the C<$scalar>. |
2026 | |
2079 | |
2027 | On systems that do not implement C<posix_madvise>, this function returns |
2080 | On systems that do not implement C<posix_madvise>, this function returns |
2028 | ENOSYS, otherwise the return value of C<posix_madvise>. |
2081 | ENOSYS, otherwise the return value of C<posix_madvise>. |
2029 | |
2082 | |
2030 | =item IO::AIO::mprotect $scalar, $offset, $len, $protect |
2083 | =item IO::AIO::mprotect $scalar, $offset, $len, $protect |
… | |
… | |
2032 | Simply calls the C<mprotect> function on the preferably AIO::mmap'ed |
2085 | Simply calls the C<mprotect> function on the preferably AIO::mmap'ed |
2033 | $scalar (see its manpage for details). The following protect |
2086 | $scalar (see its manpage for details). The following protect |
2034 | constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>, |
2087 | constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>, |
2035 | C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>. |
2088 | C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>. |
2036 | |
2089 | |
|
|
2090 | If C<$offset> is negative, counts from the end. If C<$length> is negative, |
|
|
2091 | the remaining length of the C<$scalar> is used. If possible, C<$length> |
|
|
2092 | will be reduced to fit into the C<$scalar>. |
|
|
2093 | |
2037 | On systems that do not implement C<mprotect>, this function returns |
2094 | On systems that do not implement C<mprotect>, this function returns |
2038 | ENOSYS, otherwise the return value of C<mprotect>. |
2095 | ENOSYS, otherwise the return value of C<mprotect>. |
2039 | |
2096 | |
2040 | =item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] |
2097 | =item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] |
2041 | |
2098 | |
2042 | Memory-maps a file (or anonymous memory range) and attaches it to the |
2099 | Memory-maps a file (or anonymous memory range) and attaches it to the |
2043 | given C<$scalar>, which will act like a string scalar. Returns true on |
2100 | given C<$scalar>, which will act like a string scalar. Returns true on |
2044 | success, and false otherwise. |
2101 | success, and false otherwise. |
2045 | |
2102 | |
|
|
2103 | The scalar must exist, but its contents do not matter - this means you |
|
|
2104 | cannot use a nonexistant array or hash element. When in doubt, C<undef> |
|
|
2105 | the scalar first. |
|
|
2106 | |
2046 | The only operations allowed on the scalar are C<substr>/C<vec> that don't |
2107 | The only operations allowed on the mmapped scalar are C<substr>/C<vec>, |
2047 | change the string length, and most read-only operations such as copying it |
2108 | which don't change the string length, and most read-only operations such |
2048 | or searching it with regexes and so on. |
2109 | as copying it or searching it with regexes and so on. |
2049 | |
2110 | |
2050 | Anything else is unsafe and will, at best, result in memory leaks. |
2111 | Anything else is unsafe and will, at best, result in memory leaks. |
2051 | |
2112 | |
2052 | The memory map associated with the C<$scalar> is automatically removed |
2113 | The memory map associated with the C<$scalar> is automatically removed |
2053 | when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or |
2114 | when the C<$scalar> is undef'd or destroyed, or when the C<IO::AIO::mmap> |
2054 | C<IO::AIO::munmap> functions are called. |
2115 | or C<IO::AIO::munmap> functions are called on it. |
2055 | |
2116 | |
2056 | This calls the C<mmap>(2) function internally. See your system's manual |
2117 | This calls the C<mmap>(2) function internally. See your system's manual |
2057 | page for details on the C<$length>, C<$prot> and C<$flags> parameters. |
2118 | page for details on the C<$length>, C<$prot> and C<$flags> parameters. |
2058 | |
2119 | |
2059 | The C<$length> must be larger than zero and smaller than the actual |
2120 | The C<$length> must be larger than zero and smaller than the actual |
… | |
… | |
2156 | |
2217 | |
2157 | Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the |
2218 | Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the |
2158 | time of this writing, C<IO::AIO::O_CLOEXEC>, C<IO::AIO::O_NONBLOCK> and |
2219 | time of this writing, C<IO::AIO::O_CLOEXEC>, C<IO::AIO::O_NONBLOCK> and |
2159 | C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported. |
2220 | C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported. |
2160 | |
2221 | |
|
|
2222 | Example: create a pipe race-free w.r.t. threads and fork: |
|
|
2223 | |
|
|
2224 | my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC |
|
|
2225 | or die "pipe2: $!\n"; |
|
|
2226 | |
|
|
2227 | =item $fh = IO::AIO::eventfd [$initval, [$flags]] |
|
|
2228 | |
|
|
2229 | This is a direct interface to the Linux L<eventfd(2)> system call. The |
|
|
2230 | (unhelpful) defaults for C<$initval> and C<$flags> are C<0> for both. |
|
|
2231 | |
|
|
2232 | On success, the new eventfd filehandle is returned, otherwise returns |
|
|
2233 | C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>. |
|
|
2234 | |
|
|
2235 | Please refer to L<eventfd(2)> for more info on this call. |
|
|
2236 | |
|
|
2237 | The following symbol flag values are available: C<IO::AIO::EFD_CLOEXEC>, |
|
|
2238 | C<IO::AIO::EFD_NONBLOCK> and C<IO::AIO::EFD_SEMAPHORE> (Linux 2.6.30). |
|
|
2239 | |
|
|
2240 | Example: create a new eventfd filehandle: |
|
|
2241 | |
|
|
2242 | $fh = IO::AIO::eventfd 0, IO::AIO::O_CLOEXEC |
|
|
2243 | or die "eventfd: $!\n"; |
|
|
2244 | |
|
|
2245 | =item $fh = IO::AIO::timerfd_create $clockid[, $flags] |
|
|
2246 | |
|
|
2247 | This is a direct interface to the Linux L<timerfd_create(2)> system call. The |
|
|
2248 | (unhelpful) default for C<$flags> is C<0>. |
|
|
2249 | |
|
|
2250 | On success, the new timerfd filehandle is returned, otherwise returns |
|
|
2251 | C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>. |
|
|
2252 | |
|
|
2253 | Please refer to L<timerfd_create(2)> for more info on this call. |
|
|
2254 | |
|
|
2255 | The following C<$clockid> values are |
|
|
2256 | available: C<IO::AIO::CLOCK_REALTIME>, C<IO::AIO::CLOCK_MONOTONIC> |
|
|
2257 | C<IO::AIO::CLOCK_CLOCK_BOOTTIME> (Linux 3.15) |
|
|
2258 | C<IO::AIO::CLOCK_CLOCK_REALTIME_ALARM> (Linux 3.11) and |
|
|
2259 | C<IO::AIO::CLOCK_CLOCK_BOOTTIME_ALARM> (Linux 3.11). |
|
|
2260 | |
|
|
2261 | The following C<$flags> values are available (Linux |
|
|
2262 | 2.6.27): C<IO::AIO::TFD_NONBLOCK> and C<IO::AIO::TFD_CLOEXEC>. |
|
|
2263 | |
|
|
2264 | Example: create a new timerfd and set it to one-second repeated alarms, |
|
|
2265 | then wait for two alarms: |
|
|
2266 | |
|
|
2267 | my $fh = IO::AIO::timerfd_create IO::AIO::CLOCK_BOOTTIME, IO::AIO::TFD_CLOEXEC |
|
|
2268 | or die "timerfd_create: $!\n"; |
|
|
2269 | |
|
|
2270 | defined IO::AIO::timerfd_settime $fh, 0, 1, 1 |
|
|
2271 | or die "timerfd_settime: $!\n"; |
|
|
2272 | |
|
|
2273 | for (1..2) { |
|
|
2274 | 8 == sysread $fh, my $buf, 8 |
|
|
2275 | or die "timerfd read failure\n"; |
|
|
2276 | |
|
|
2277 | printf "number of expirations (likely 1): %d\n", |
|
|
2278 | unpack "Q", $buf; |
|
|
2279 | } |
|
|
2280 | |
|
|
2281 | =item ($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags, $new_interval, $nbw_value |
|
|
2282 | |
|
|
2283 | This is a direct interface to the Linux L<timerfd_settime(2)> system |
|
|
2284 | call. Please refer to its manpage for more info on this call. |
|
|
2285 | |
|
|
2286 | The new itimerspec is specified using two (possibly fractional) second |
|
|
2287 | values, C<$new_interval> and C<$new_value>). |
|
|
2288 | |
|
|
2289 | On success, the current interval and value are returned (as per |
|
|
2290 | C<timerfd_gettime>). On failure, the empty list is returned. |
|
|
2291 | |
|
|
2292 | The following C<$flags> values are |
|
|
2293 | available: C<IO::AIO::TFD_TIMER_ABSTIME> and |
|
|
2294 | C<IO::AIO::TFD_TIMER_CANCEL_ON_SET>. |
|
|
2295 | |
|
|
2296 | See C<IO::AIO::timerfd_create> for a full example. |
|
|
2297 | |
|
|
2298 | =item ($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh |
|
|
2299 | |
|
|
2300 | This is a direct interface to the Linux L<timerfd_gettime(2)> system |
|
|
2301 | call. Please refer to its manpage for more info on this call. |
|
|
2302 | |
|
|
2303 | On success, returns the current values of interval and value for the given |
|
|
2304 | timerfd (as potentially fractional second values). On failure, the empty |
|
|
2305 | list is returned. |
|
|
2306 | |
2161 | =back |
2307 | =back |
2162 | |
2308 | |
2163 | =cut |
2309 | =cut |
2164 | |
2310 | |
2165 | min_parallel 8; |
2311 | min_parallel 8; |
… | |
… | |
2230 | the process will result in undefined behaviour. Calling it at any time |
2376 | the process will result in undefined behaviour. Calling it at any time |
2231 | will also result in any undefined (by POSIX) behaviour. |
2377 | will also result in any undefined (by POSIX) behaviour. |
2232 | |
2378 | |
2233 | =back |
2379 | =back |
2234 | |
2380 | |
|
|
2381 | =head2 LINUX-SPECIFIC CALLS |
|
|
2382 | |
|
|
2383 | When a call is documented as "linux-specific" then this means it |
|
|
2384 | originated on GNU/Linux. C<IO::AIO> will usually try to autodetect the |
|
|
2385 | availability and compatibility of such calls regardless of the platform |
|
|
2386 | it is compiled on, so platforms such as FreeBSD which often implement |
|
|
2387 | these calls will work. When in doubt, call them and see if they fail wth |
|
|
2388 | C<ENOSYS>. |
|
|
2389 | |
2235 | =head2 MEMORY USAGE |
2390 | =head2 MEMORY USAGE |
2236 | |
2391 | |
2237 | Per-request usage: |
2392 | Per-request usage: |
2238 | |
2393 | |
2239 | Each aio request uses - depending on your architecture - around 100-200 |
2394 | Each aio request uses - depending on your architecture - around 100-200 |
… | |
… | |
2251 | temporary buffers, and each thread requires a stack and other data |
2406 | temporary buffers, and each thread requires a stack and other data |
2252 | structures (usually around 16k-128k, depending on the OS). |
2407 | structures (usually around 16k-128k, depending on the OS). |
2253 | |
2408 | |
2254 | =head1 KNOWN BUGS |
2409 | =head1 KNOWN BUGS |
2255 | |
2410 | |
2256 | Known bugs will be fixed in the next release. |
2411 | Known bugs will be fixed in the next release :) |
|
|
2412 | |
|
|
2413 | =head1 KNOWN ISSUES |
|
|
2414 | |
|
|
2415 | Calls that try to "import" foreign memory areas (such as C<IO::AIO::mmap> |
|
|
2416 | or C<IO::AIO::aio_slurp>) do not work with generic lvalues, such as |
|
|
2417 | non-created hash slots or other scalars I didn't think of. It's best to |
|
|
2418 | avoid such and either use scalar variables or making sure that the scalar |
|
|
2419 | exists (e.g. by storing C<undef>) and isn't "funny" (e.g. tied). |
|
|
2420 | |
|
|
2421 | I am not sure anything can be done about this, so this is considered a |
|
|
2422 | known issue, rather than a bug. |
2257 | |
2423 | |
2258 | =head1 SEE ALSO |
2424 | =head1 SEE ALSO |
2259 | |
2425 | |
2260 | L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a |
2426 | L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a |
2261 | more natural syntax. |
2427 | more natural syntax. |