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.262 by root, Thu Jun 9 03:15:37 2016 UTC vs.
Revision 1.304 by root, Wed Apr 3 03:11:45 2019 UTC

1=head1 NAME 1=head1 NAME
2 2
3IO::AIO - Asynchronous Input/Output 3IO::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
… …
58not well-supported or restricted (GNU/Linux doesn't allow them on normal 58not well-supported or restricted (GNU/Linux doesn't allow them on normal
59files currently, for example), and they would only support aio_read and 59files currently, for example), and they would only support aio_read and
60aio_write, so the remaining functionality would have to be implemented 60aio_write, so the remaining functionality would have to be implemented
61using threads anyway. 61using threads anyway.
62 62
63In addition to asynchronous I/O, this module also exports some rather
64arcane interfaces, such as C<madvise> or linux's C<splice> system call,
65which is why the C<A> in C<AIO> can also mean I<advanced>.
66
63Although the module will work in the presence of other (Perl-) threads, 67Although the module will work in the presence of other (Perl-) threads,
64it is currently not reentrant in any way, so use appropriate locking 68it is currently not reentrant in any way, so use appropriate locking
65yourself, always call C<poll_cb> from within the same thread, or never 69yourself, always call C<poll_cb> from within the same thread, or never
66call C<poll_cb> (or other C<aio_> functions) recursively. 70call C<poll_cb> (or other C<aio_> functions) recursively.
67 71
… …
167use common::sense; 171use common::sense;
168 172
169use base 'Exporter'; 173use base 'Exporter';
170 174
171BEGIN { 175BEGIN {
172 our $VERSION = 4.34; 176 our $VERSION = 4.72;
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_fcntl aio_ioctl 180 aio_scandir aio_symlink aio_readlink aio_realpath aio_fcntl aio_ioctl
177 aio_sync aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range 181 aio_sync aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range
178 aio_pathsync aio_readahead aio_fiemap aio_allocate 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
189 nreqs nready npending nthreads 194 nreqs nready npending nthreads
190 max_poll_time max_poll_reqs 195 max_poll_time max_poll_reqs
191 sendfile fadvise madvise 196 sendfile fadvise madvise
192 mmap munmap munlock munlockall); 197 mmap munmap mremap munlock munlockall);
193 198
194 push @AIO_REQ, qw(aio_busy); # not exported 199 push @AIO_REQ, qw(aio_busy); # not exported
195 200
196 @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; 201 @IO::AIO::GRP::ISA = 'IO::AIO::REQ';
197 202
… …
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
… …
248 aio_syncfs $fh, $callback->($status) 254 aio_syncfs $fh, $callback->($status)
249 aio_fsync $fh, $callback->($status) 255 aio_fsync $fh, $callback->($status)
250 aio_fdatasync $fh, $callback->($status) 256 aio_fdatasync $fh, $callback->($status)
251 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) 257 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
252 aio_pathsync $pathname, $callback->($status) 258 aio_pathsync $pathname, $callback->($status)
253 aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 259 aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status)
254 aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 260 aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
255 aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) 261 aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
256 aio_mlockall $flags, $callback->($status) 262 aio_mlockall $flags, $callback->($status)
257 aio_group $callback->(...) 263 aio_group $callback->(...)
258 aio_nop $callback->() 264 aio_nop $callback->()
… …
272 IO::AIO::idle_timeout $seconds 278 IO::AIO::idle_timeout $seconds
273 IO::AIO::max_outstanding $maxreqs 279 IO::AIO::max_outstanding $maxreqs
274 IO::AIO::nreqs 280 IO::AIO::nreqs
275 IO::AIO::nready 281 IO::AIO::nready
276 IO::AIO::npending 282 IO::AIO::npending
283 IO::AIO::reinit
284
285 $nfd = IO::AIO::get_fdlimit [EXPERIMENTAL]
286 IO::AIO::min_fdlimit $nfd [EXPERIMENTAL]
277 287
278 IO::AIO::sendfile $ofh, $ifh, $offset, $count 288 IO::AIO::sendfile $ofh, $ifh, $offset, $count
279 IO::AIO::fadvise $fh, $offset, $len, $advice 289 IO::AIO::fadvise $fh, $offset, $len, $advice
290
280 IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]] 291 IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]
281 IO::AIO::munmap $scalar 292 IO::AIO::munmap $scalar
293 IO::AIO::mremap $scalar, $new_length, $flags[, $new_address]
282 IO::AIO::madvise $scalar, $offset, $length, $advice 294 IO::AIO::madvise $scalar, $offset, $length, $advice
283 IO::AIO::mprotect $scalar, $offset, $length, $protect 295 IO::AIO::mprotect $scalar, $offset, $length, $protect
284 IO::AIO::munlock $scalar, $offset = 0, $length = undef 296 IO::AIO::munlock $scalar, $offset = 0, $length = undef
285 IO::AIO::munlockall 297 IO::AIO::munlockall
298
299 # stat extensions
300 $counter = IO::AIO::st_gen
301 $seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime, IO::AIO::st_btime
302 ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime
303 $nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, IO::AIO::st_ctimensec, IO::AIO::st_btimensec
304 $seconds = IO::AIO::st_btimesec
305 ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtimensec
306
307 # very much unportable syscalls
308 IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
309 IO::AIO::tee $r_fh, $w_fh, $length, $flags
310 $actual_size = IO::AIO::pipesize $r_fh[, $new_size]
311 ($rfh, $wfh) = IO::AIO::pipe2 [$flags]
312 $fh = IO::AIO::memfd_create $pathname[, $flags]
313 $fh = IO::AIO::eventfd [$initval, [$flags]]
314 $fh = IO::AIO::timerfd_create $clockid[, $flags]
315 ($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags, $new_interval, $nbw_value
316 ($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh
286 317
287=head2 API NOTES 318=head2 API NOTES
288 319
289All the C<aio_*> calls are more or less thin wrappers around the syscall 320All the C<aio_*> calls are more or less thin wrappers around the syscall
290with the same name (sans C<aio_>). The arguments are similar or identical, 321with the same name (sans C<aio_>). The arguments are similar or identical,
… …
396following POSIX and non-POSIX constants are available (missing ones on 427following POSIX and non-POSIX constants are available (missing ones on
397your system are, as usual, C<0>): 428your system are, as usual, C<0>):
398 429
399C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>, 430C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>,
400C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>, 431C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>,
401C<O_RSYNC>, C<O_SYNC>, C<O_PATH>, C<O_TMPFILE>, and C<O_TTY_INIT>. 432C<O_RSYNC>, C<O_SYNC>, C<O_PATH>, C<O_TMPFILE>, C<O_TTY_INIT> and C<O_ACCMODE>.
402 433
403 434
404=item aio_close $fh, $callback->($status) 435=item aio_close $fh, $callback->($status)
405 436
406Asynchronously close a file and call the callback with the result 437Asynchronously close a file and call the callback with the result
… …
441=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 472=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
442 473
443=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 474=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
444 475
445Reads or writes C<$length> bytes from or to the specified C<$fh> and 476Reads or writes C<$length> bytes from or to the specified C<$fh> and
446C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> 477C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> and
447and calls the callback without the actual number of bytes read (or -1 on 478calls the callback with the actual number of bytes transferred (or -1 on
448error, just like the syscall). 479error, just like the syscall).
449 480
450C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to 481C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to
451offset plus the actual number of bytes read. 482offset plus the actual number of bytes read.
452 483
… …
532 563
533=item aio_stat $fh_or_path, $callback->($status) 564=item aio_stat $fh_or_path, $callback->($status)
534 565
535=item aio_lstat $fh, $callback->($status) 566=item aio_lstat $fh, $callback->($status)
536 567
537Works like perl's C<stat> or C<lstat> in void context. The callback will 568Works almost exactly like perl's C<stat> or C<lstat> in void context. The
538be called after the stat and the results will be available using C<stat _> 569callback will be called after the stat and the results will be available
539or C<-s _> etc... 570using C<stat _> or C<-s _> and other tests (with the exception of C<-B>
571and C<-T>).
540 572
541The pathname passed to C<aio_stat> must be absolute. See API NOTES, above, 573The pathname passed to C<aio_stat> must be absolute. See API NOTES, above,
542for an explanation. 574for an explanation.
543 575
544Currently, the stats are always 64-bit-stats, i.e. instead of returning an 576Currently, the stats are always 64-bit-stats, i.e. instead of returning an
… …
551behaviour). 583behaviour).
552 584
553C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>, 585C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>,
554C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>, 586C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>,
555C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>. 587C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>.
588
589To access higher resolution stat timestamps, see L<SUBSECOND STAT TIME
590ACCESS>.
556 591
557Example: Print the length of F</etc/passwd>: 592Example: Print the length of F</etc/passwd>:
558 593
559 aio_stat "/etc/passwd", sub { 594 aio_stat "/etc/passwd", sub {
560 $_[0] and die "stat failed: $!"; 595 $_[0] and die "stat failed: $!";
… …
604 namemax => 255, 639 namemax => 255,
605 frsize => 1024, 640 frsize => 1024,
606 fsid => 1810 641 fsid => 1810
607 } 642 }
608 643
609Here is a (likely partial - send me updates!) list of fsid values used by
610Linux - it is safe to hardcode these when C<$^O> is C<linux>:
611
612 0x0000adf5 adfs
613 0x0000adff affs
614 0x5346414f afs
615 0x09041934 anon-inode filesystem
616 0x00000187 autofs
617 0x42465331 befs
618 0x1badface bfs
619 0x42494e4d binfmt_misc
620 0x9123683e btrfs
621 0x0027e0eb cgroupfs
622 0xff534d42 cifs
623 0x73757245 coda
624 0x012ff7b7 coh
625 0x28cd3d45 cramfs
626 0x453dcd28 cramfs-wend (wrong endianness)
627 0x64626720 debugfs
628 0x00001373 devfs
629 0x00001cd1 devpts
630 0x0000f15f ecryptfs
631 0x00414a53 efs
632 0x0000137d ext
633 0x0000ef53 ext2/ext3/ext4
634 0x0000ef51 ext2
635 0xf2f52010 f2fs
636 0x00004006 fat
637 0x65735546 fuseblk
638 0x65735543 fusectl
639 0x0bad1dea futexfs
640 0x01161970 gfs2
641 0x47504653 gpfs
642 0x00004244 hfs
643 0xf995e849 hpfs
644 0x00c0ffee hostfs
645 0x958458f6 hugetlbfs
646 0x2bad1dea inotifyfs
647 0x00009660 isofs
648 0x000072b6 jffs2
649 0x3153464a jfs
650 0x6b414653 k-afs
651 0x0bd00bd0 lustre
652 0x0000137f minix
653 0x0000138f minix 30 char names
654 0x00002468 minix v2
655 0x00002478 minix v2 30 char names
656 0x00004d5a minix v3
657 0x19800202 mqueue
658 0x00004d44 msdos
659 0x0000564c novell
660 0x00006969 nfs
661 0x6e667364 nfsd
662 0x00003434 nilfs
663 0x5346544e ntfs
664 0x00009fa1 openprom
665 0x7461636F ocfs2
666 0x00009fa0 proc
667 0x6165676c pstorefs
668 0x0000002f qnx4
669 0x68191122 qnx6
670 0x858458f6 ramfs
671 0x52654973 reiserfs
672 0x00007275 romfs
673 0x67596969 rpc_pipefs
674 0x73636673 securityfs
675 0xf97cff8c selinux
676 0x0000517b smb
677 0x534f434b sockfs
678 0x73717368 squashfs
679 0x62656572 sysfs
680 0x012ff7b6 sysv2
681 0x012ff7b5 sysv4
682 0x01021994 tmpfs
683 0x15013346 udf
684 0x00011954 ufs
685 0x54190100 ufs byteswapped
686 0x00009fa2 usbdevfs
687 0x01021997 v9fs
688 0xa501fcf5 vxfs
689 0xabba1974 xenfs
690 0x012ff7b4 xenix
691 0x58465342 xfs
692 0x012fd16d xia
693
694=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 644=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
695 645
696Works like perl's C<utime> function (including the special case of $atime 646Works like perl's C<utime> function (including the special case of $atime
697and $mtime being undef). Fractional times are supported if the underlying 647and $mtime being undef). Fractional times are supported if the underlying
698syscalls support them. 648syscalls support them.
699 649
700When called with a pathname, uses utimes(2) if available, otherwise 650When called with a pathname, uses utimensat(2) or utimes(2) if available,
701utime(2). If called on a file descriptor, uses futimes(2) if available, 651otherwise utime(2). If called on a file descriptor, uses futimens(2)
702otherwise returns ENOSYS, so this is not portable. 652or futimes(2) if available, otherwise returns ENOSYS, so this is not
653portable.
703 654
704Examples: 655Examples:
705 656
706 # set atime and mtime to current time (basically touch(1)): 657 # set atime and mtime to current time (basically touch(1)):
707 aio_utime "path", undef, undef; 658 aio_utime "path", undef, undef;
… …
735C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate 686C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate
736space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE | IO::AIO::FALLOC_FL_KEEP_SIZE>, 687space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE | IO::AIO::FALLOC_FL_KEEP_SIZE>,
737to deallocate a file range. 688to deallocate a file range.
738 689
739IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range 690IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range
740(without leaving a hole) and C<FALLOC_FL_ZERO_RANGE>, to zero a range (see 691(without leaving a hole), C<FALLOC_FL_ZERO_RANGE>, to zero a range,
741your L<fallocate(2)> manpage). 692C<FALLOC_FL_INSERT_RANGE> to insert a range and C<FALLOC_FL_UNSHARE_RANGE>
693to unshare shared blocks (see your L<fallocate(2)> manpage).
742 694
743The file system block size used by C<fallocate> is presumably the 695The file system block size used by C<fallocate> is presumably the
744C<f_bsize> returned by C<statvfs>. 696C<f_bsize> returned by C<statvfs>, but different filesystems and filetypes
697can dictate other limitations.
745 698
746If C<fallocate> isn't available or cannot be emulated (currently no 699If C<fallocate> isn't available or cannot be emulated (currently no
747emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>. 700emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>.
748 701
749 702
… …
808On systems that support the AIO::WD working directory abstraction 761On systems that support the AIO::WD working directory abstraction
809natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead 762natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead
810of failing, C<rename> is called on the absolute path of C<$wd>. 763of failing, C<rename> is called on the absolute path of C<$wd>.
811 764
812 765
766=item aio_rename2 $srcpath, $dstpath, $flags, $callback->($status)
767
768Basically a version of C<aio_rename> with an additional C<$flags>
769argument. Calling this with C<$flags=0> is the same as calling
770C<aio_rename>.
771
772Non-zero flags are currently only supported on GNU/Linux systems that
773support renameat2. Other systems fail with C<ENOSYS> in this case.
774
775The following constants are available (missing ones are, as usual C<0>),
776see renameat2(2) for details:
777
778C<IO::AIO::RENAME_NOREPLACE>, C<IO::AIO::RENAME_EXCHANGE>
779and C<IO::AIO::RENAME_WHITEOUT>.
780
781
813=item aio_mkdir $pathname, $mode, $callback->($status) 782=item aio_mkdir $pathname, $mode, $callback->($status)
814 783
815Asynchronously mkdir (create) a directory and call the callback with 784Asynchronously mkdir (create) a directory and call the callback with
816the result code. C<$mode> will be modified by the umask at the time the 785the result code. C<$mode> will be modified by the umask at the time the
817request is executed, so do not change your umask. 786request is executed, so do not change your umask.
… …
848 817
849=over 4 818=over 4
850 819
851=item IO::AIO::READDIR_DENTS 820=item IO::AIO::READDIR_DENTS
852 821
853When this flag is off, then the callback gets an arrayref consisting of 822Normally the callback gets an arrayref consisting of names only (as
854names only (as with C<aio_readdir>), otherwise it gets an arrayref with 823with C<aio_readdir>). If this flag is set, then the callback gets an
855C<[$name, $type, $inode]> arrayrefs, each describing a single directory 824arrayref with C<[$name, $type, $inode]> arrayrefs, each describing a
856entry in more detail. 825single directory entry in more detail:
857 826
858C<$name> is the name of the entry. 827C<$name> is the name of the entry.
859 828
860C<$type> is one of the C<IO::AIO::DT_xxx> constants: 829C<$type> is one of the C<IO::AIO::DT_xxx> constants:
861 830
862C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>, 831C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>,
863C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>, 832C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>,
864C<IO::AIO::DT_WHT>. 833C<IO::AIO::DT_WHT>.
865 834
866C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to 835C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need
867know, you have to run stat yourself. Also, for speed reasons, the C<$type> 836to know, you have to run stat yourself. Also, for speed/memory reasons,
868scalars are read-only: you can not modify them. 837the C<$type> scalars are read-only: you must not modify them.
869 838
870C<$inode> is the inode number (which might not be exact on systems with 64 839C<$inode> is the inode number (which might not be exact on systems with 64
871bit inode numbers and 32 bit perls). This field has unspecified content on 840bit inode numbers and 32 bit perls). This field has unspecified content on
872systems that do not deliver the inode information. 841systems that do not deliver the inode information.
873 842
… …
884short names are tried first. 853short names are tried first.
885 854
886=item IO::AIO::READDIR_STAT_ORDER 855=item IO::AIO::READDIR_STAT_ORDER
887 856
888When this flag is set, then the names will be returned in an order 857When this flag is set, then the names will be returned in an order
889suitable for stat()'ing each one. That is, when you plan to stat() 858suitable for stat()'ing each one. That is, when you plan to stat() most or
890all files in the given directory, then the returned order will likely 859all files in the given directory, then the returned order will likely be
891be fastest. 860faster.
892 861
893If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, then 862If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified,
894the likely dirs come first, resulting in a less optimal stat order. 863then the likely dirs come first, resulting in a less optimal stat order
864for stat'ing all entries, but likely a more optimal order for finding
865subdirectories.
895 866
896=item IO::AIO::READDIR_FOUND_UNKNOWN 867=item IO::AIO::READDIR_FOUND_UNKNOWN
897 868
898This flag should not be set when calling C<aio_readdirx>. Instead, it 869This flag should not be set when calling C<aio_readdirx>. Instead, it
899is being set by C<aio_readdirx>, when any of the C<$type>'s found were 870is being set by C<aio_readdirx>, when any of the C<$type>'s found were
… …
901C<$type>'s are known, which can be used to speed up some algorithms. 872C<$type>'s are known, which can be used to speed up some algorithms.
902 873
903=back 874=back
904 875
905 876
877=item aio_slurp $pathname, $offset, $length, $data, $callback->($status)
878
879Opens, reads and closes the given file. The data is put into C<$data>,
880which is resized as required.
881
882If C<$offset> is negative, then it is counted from the end of the file.
883
884If C<$length> is zero, then the remaining length of the file is
885used. Also, in this case, the same limitations to modifying C<$data> apply
886as when IO::AIO::mmap is used, i.e. it must only be modified in-place
887with C<substr>. If the size of the file is known, specifying a non-zero
888C<$length> results in a performance advantage.
889
890This request is similar to the older C<aio_load> request, but since it is
891a single request, it might be more efficient to use.
892
893Example: load F</etc/passwd> into C<$passwd>.
894
895 my $passwd;
896 aio_slurp "/etc/passwd", 0, 0, $passwd, sub {
897 $_[0] >= 0
898 or die "/etc/passwd: $!\n";
899
900 printf "/etc/passwd is %d bytes long, and contains:\n", length $passwd;
901 print $passwd;
902 };
903 IO::AIO::flush;
904
905
906=item aio_load $pathname, $data, $callback->($status) 906=item aio_load $pathname, $data, $callback->($status)
907 907
908This is a composite request that tries to fully load the given file into 908This is a composite request that tries to fully load the given file into
909memory. Status is the same as with aio_read. 909memory. Status is the same as with aio_read.
910
911Using C<aio_slurp> might be more efficient, as it is a single request.
910 912
911=cut 913=cut
912 914
913sub aio_load($$;$) { 915sub aio_load($$;$) {
914 my ($path, undef, $cb) = @_; 916 my ($path, undef, $cb) = @_;
… …
934=item aio_copy $srcpath, $dstpath, $callback->($status) 936=item aio_copy $srcpath, $dstpath, $callback->($status)
935 937
936Try to copy the I<file> (directories not supported as either source or 938Try to copy the I<file> (directories not supported as either source or
937destination) from C<$srcpath> to C<$dstpath> and call the callback with 939destination) from C<$srcpath> to C<$dstpath> and call the callback with
938a status of C<0> (ok) or C<-1> (error, see C<$!>). 940a status of C<0> (ok) or C<-1> (error, see C<$!>).
941
942Existing destination files will be truncated.
939 943
940This is a composite request that creates the destination file with 944This is a composite request that creates the destination file with
941mode 0200 and copies the contents of the source file into it using 945mode 0200 and copies the contents of the source file into it using
942C<aio_sendfile>, followed by restoring atime, mtime, access mode and 946C<aio_sendfile>, followed by restoring atime, mtime, access mode and
943uid/gid, in that order. 947uid/gid, in that order.
… …
1053Scans a directory (similar to C<aio_readdir>) but additionally tries to 1057Scans a directory (similar to C<aio_readdir>) but additionally tries to
1054efficiently separate the entries of directory C<$path> into two sets of 1058efficiently separate the entries of directory C<$path> into two sets of
1055names, directories you can recurse into (directories), and ones you cannot 1059names, directories you can recurse into (directories), and ones you cannot
1056recurse into (everything else, including symlinks to directories). 1060recurse into (everything else, including symlinks to directories).
1057 1061
1058C<aio_scandir> is a composite request that creates of many sub requests_ 1062C<aio_scandir> is a composite request that generates many sub requests.
1059C<$maxreq> specifies the maximum number of outstanding aio requests that 1063C<$maxreq> specifies the maximum number of outstanding aio requests that
1060this function generates. If it is C<< <= 0 >>, then a suitable default 1064this function generates. If it is C<< <= 0 >>, then a suitable default
1061will be chosen (currently 4). 1065will be chosen (currently 4).
1062 1066
1063On error, the callback is called without arguments, otherwise it receives 1067On error, the callback is called without arguments, otherwise it receives
… …
1127 aioreq_pri $pri; 1131 aioreq_pri $pri;
1128 add $grp aio_stat $wd, sub { 1132 add $grp aio_stat $wd, sub {
1129 return $grp->result () if $_[0]; 1133 return $grp->result () if $_[0];
1130 my $now = time; 1134 my $now = time;
1131 my $hash1 = join ":", (stat _)[0,1,3,7,9]; 1135 my $hash1 = join ":", (stat _)[0,1,3,7,9];
1136 my $rdxflags = READDIR_DIRS_FIRST;
1137
1138 if ((stat _)[3] < 2) {
1139 # at least one non-POSIX filesystem exists
1140 # that returns useful DT_type values: btrfs,
1141 # so optimise for this here by requesting dents
1142 $rdxflags |= READDIR_DENTS;
1143 }
1132 1144
1133 # read the directory entries 1145 # read the directory entries
1134 aioreq_pri $pri; 1146 aioreq_pri $pri;
1135 add $grp aio_readdirx $wd, READDIR_DIRS_FIRST, sub { 1147 add $grp aio_readdirx $wd, $rdxflags, sub {
1136 my $entries = shift 1148 my ($entries, $flags) = @_
1137 or return $grp->result (); 1149 or return $grp->result ();
1150
1151 if ($rdxflags & READDIR_DENTS) {
1152 # if we requested type values, see if we can use them directly.
1153
1154 # if there were any DT_UNKNOWN entries then we assume we
1155 # don't know. alternatively, we could assume that if we get
1156 # one DT_DIR, then all directories are indeed marked with
1157 # DT_DIR, but this seems not required for btrfs, and this
1158 # is basically the "btrfs can't get it's act together" code
1159 # branch.
1160 unless ($flags & READDIR_FOUND_UNKNOWN) {
1161 # now we have valid DT_ information for all entries,
1162 # so use it as an optimisation without further stat's.
1163 # they must also all be at the beginning of @$entries
1164 # by now.
1165
1166 my $dirs;
1167
1168 if (@$entries) {
1169 for (0 .. $#$entries) {
1170 if ($entries->[$_][1] != DT_DIR) {
1171 # splice out directories
1172 $dirs = [splice @$entries, 0, $_];
1173 last;
1174 }
1175 }
1176
1177 # if we didn't find any non-dir, then all entries are dirs
1178 unless ($dirs) {
1179 ($dirs, $entries) = ($entries, []);
1180 }
1181 } else {
1182 # directory is empty, so there are no sbdirs
1183 $dirs = [];
1184 }
1185
1186 # either splice'd the directories out or the dir was empty.
1187 # convert dents to filenames
1188 $_ = $_->[0] for @$dirs;
1189 $_ = $_->[0] for @$entries;
1190
1191 return $grp->result ($dirs, $entries);
1192 }
1193
1194 # cannot use, so return to our old ways
1195 # by pretending we only scanned for names.
1196 $_ = $_->[0] for @$entries;
1197 }
1138 1198
1139 # stat the dir another time 1199 # stat the dir another time
1140 aioreq_pri $pri; 1200 aioreq_pri $pri;
1141 add $grp aio_stat $wd, sub { 1201 add $grp aio_stat $wd, sub {
1142 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 1202 my $hash2 = join ":", (stat _)[0,1,3,7,9];
… …
1248So in general, you should only use these calls for things that do 1308So in general, you should only use these calls for things that do
1249(filesystem) I/O, not for things that wait for other events (network, 1309(filesystem) I/O, not for things that wait for other events (network,
1250other processes), although if you are careful and know what you are doing, 1310other processes), although if you are careful and know what you are doing,
1251you still can. 1311you still can.
1252 1312
1313The following constants are available and can be used for normal C<ioctl>
1314and C<fcntl> as well (missing ones are, as usual C<0>):
1315
1316C<F_DUPFD_CLOEXEC>,
1317
1318C<F_OFD_GETLK>, C<F_OFD_SETLK>, C<F_OFD_GETLKW>,
1319
1320C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>.
1321
1322C<F_ADD_SEALS>, C<F_GET_SEALS>, C<F_SEAL_SEAL>, C<F_SEAL_SHRINK>, C<F_SEAL_GROW> and
1323C<F_SEAL_WRITE>.
1324
1325C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>,
1326C<FS_IOC_FIEMAP>.
1327
1328C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>,
1329C<FS_IOC_GET_ENCRYPTION_PWSALT>, C<FS_IOC_GET_ENCRYPTION_POLICY>, C<FS_KEY_DESCRIPTOR_SIZE>.
1330
1331C<FS_SECRM_FL>, C<FS_UNRM_FL>, C<FS_COMPR_FL>, C<FS_SYNC_FL>, C<FS_IMMUTABLE_FL>,
1332C<FS_APPEND_FL>, C<FS_NODUMP_FL>, C<FS_NOATIME_FL>, C<FS_DIRTY_FL>,
1333C<FS_COMPRBLK_FL>, C<FS_NOCOMP_FL>, C<FS_ENCRYPT_FL>, C<FS_BTREE_FL>,
1334C<FS_INDEX_FL>, C<FS_JOURNAL_DATA_FL>, C<FS_NOTAIL_FL>, C<FS_DIRSYNC_FL>, C<FS_TOPDIR_FL>,
1335C<FS_FL_USER_MODIFIABLE>.
1336
1337C<FS_XFLAG_REALTIME>, C<FS_XFLAG_PREALLOC>, C<FS_XFLAG_IMMUTABLE>, C<FS_XFLAG_APPEND>,
1338C<FS_XFLAG_SYNC>, C<FS_XFLAG_NOATIME>, C<FS_XFLAG_NODUMP>, C<FS_XFLAG_RTINHERIT>,
1339C<FS_XFLAG_PROJINHERIT>, C<FS_XFLAG_NOSYMLINKS>, C<FS_XFLAG_EXTSIZE>, C<FS_XFLAG_EXTSZINHERIT>,
1340C<FS_XFLAG_NODEFRAG>, C<FS_XFLAG_FILESTREAM>, C<FS_XFLAG_DAX>, C<FS_XFLAG_HASATTR>,
1341
1253=item aio_sync $callback->($status) 1342=item aio_sync $callback->($status)
1254 1343
1255Asynchronously call sync and call the callback when finished. 1344Asynchronously call sync and call the callback when finished.
1256 1345
1257=item aio_fsync $fh, $callback->($status) 1346=item aio_fsync $fh, $callback->($status)
… …
1325 }; 1414 };
1326 1415
1327 $grp 1416 $grp
1328} 1417}
1329 1418
1330=item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 1419=item aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status)
1331 1420
1332This is a rather advanced IO::AIO call, which only works on mmap(2)ed 1421This is a rather advanced IO::AIO call, which only works on mmap(2)ed
1333scalars (see the C<IO::AIO::mmap> function, although it also works on data 1422scalars (see the C<IO::AIO::mmap> function, although it also works on data
1334scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the 1423scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the
1335scalar must only be modified in-place while an aio operation is pending on 1424scalar must only be modified in-place while an aio operation is pending on
… …
1337 1426
1338It calls the C<msync> function of your OS, if available, with the memory 1427It calls the C<msync> function of your OS, if available, with the memory
1339area starting at C<$offset> in the string and ending C<$length> bytes 1428area starting at C<$offset> in the string and ending C<$length> bytes
1340later. If C<$length> is negative, counts from the end, and if C<$length> 1429later. If C<$length> is negative, counts from the end, and if C<$length>
1341is C<undef>, then it goes till the end of the string. The flags can be 1430is C<undef>, then it goes till the end of the string. The flags can be
1342a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and 1431either C<IO::AIO::MS_ASYNC> or C<IO::AIO::MS_SYNC>, plus an optional
1343C<IO::AIO::MS_SYNC>. 1432C<IO::AIO::MS_INVALIDATE>.
1344 1433
1345=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 1434=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
1346 1435
1347This is a rather advanced IO::AIO call, which works best on mmap(2)ed 1436This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1348scalars. 1437scalars.
… …
1378 IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh; 1467 IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;
1379 aio_mlock $data; # mlock in background 1468 aio_mlock $data; # mlock in background
1380 1469
1381=item aio_mlockall $flags, $callback->($status) 1470=item aio_mlockall $flags, $callback->($status)
1382 1471
1383Calls the C<mlockall> function with the given C<$flags> (a combination of 1472Calls the C<mlockall> function with the given C<$flags> (a
1384C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>). 1473combination of C<IO::AIO::MCL_CURRENT>, C<IO::AIO::MCL_FUTURE> and
1474C<IO::AIO::MCL_ONFAULT>).
1385 1475
1386On systems that do not implement C<mlockall>, this function returns C<-1> 1476On systems that do not implement C<mlockall>, this function returns C<-1>
1387and sets errno to C<ENOSYS>. 1477and sets errno to C<ENOSYS>. Similarly, flag combinations not supported
1478by the system result in a return value of C<-1> with errno being set to
1479C<EINVAL>.
1388 1480
1389Note that the corresponding C<munlockall> is synchronous and is 1481Note that the corresponding C<munlockall> is synchronous and is
1390documented under L<MISCELLANEOUS FUNCTIONS>. 1482documented under L<MISCELLANEOUS FUNCTIONS>.
1391 1483
1392Example: asynchronously lock all current and future pages into memory. 1484Example: asynchronously lock all current and future pages into memory.
… …
1431C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>, 1523C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,
1432C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>, 1524C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,
1433C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or 1525C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or
1434C<IO::AIO::FIEMAP_EXTENT_SHARED>. 1526C<IO::AIO::FIEMAP_EXTENT_SHARED>.
1435 1527
1436At the time of this writing (Linux 3.2), this requets is unreliable unless 1528At the time of this writing (Linux 3.2), this request is unreliable unless
1437C<$count> is C<undef>, as the kernel has all sorts of bugs preventing 1529C<$count> is C<undef>, as the kernel has all sorts of bugs preventing
1438it to return all extents of a range for files with large number of 1530it to return all extents of a range for files with a large number of
1439extents. The code works around all these issues if C<$count> is undef. 1531extents. The code (only) works around all these issues if C<$count> is
1532C<undef>.
1440 1533
1441=item aio_group $callback->(...) 1534=item aio_group $callback->(...)
1442 1535
1443This is a very special aio request: Instead of doing something, it is a 1536This is a very special aio request: Instead of doing something, it is a
1444container for other aio requests, which is useful if you want to bundle 1537container for other aio requests, which is useful if you want to bundle
… …
1557There are some caveats: when directories get renamed (or deleted), the 1650There are some caveats: when directories get renamed (or deleted), the
1558pathname string doesn't change, so will point to the new directory (or 1651pathname string doesn't change, so will point to the new directory (or
1559nowhere at all), while the directory fd, if available on the system, 1652nowhere at all), while the directory fd, if available on the system,
1560will still point to the original directory. Most functions accepting a 1653will still point to the original directory. Most functions accepting a
1561pathname will use the directory fd on newer systems, and the string on 1654pathname will use the directory fd on newer systems, and the string on
1562older systems. Some functions (such as realpath) will always rely on the 1655older systems. Some functions (such as C<aio_realpath>) will always rely on
1563string form of the pathname. 1656the string form of the pathname.
1564 1657
1565So this functionality is mainly useful to get some protection against 1658So this functionality is mainly useful to get some protection against
1566C<chdir>, to easily get an absolute path out of a relative path for future 1659C<chdir>, to easily get an absolute path out of a relative path for future
1567reference, and to speed up doing many operations in the same directory 1660reference, and to speed up doing many operations in the same directory
1568(e.g. when stat'ing all files in a directory). 1661(e.g. when stat'ing all files in a directory).
… …
1776The default value for the limit is C<0>, but note that setting a feeder 1869The default value for the limit is C<0>, but note that setting a feeder
1777automatically bumps it up to C<2>. 1870automatically bumps it up to C<2>.
1778 1871
1779=back 1872=back
1780 1873
1874
1781=head2 SUPPORT FUNCTIONS 1875=head2 SUPPORT FUNCTIONS
1782 1876
1783=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION 1877=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
1784 1878
1785=over 4 1879=over 4
… …
1850Strictly equivalent to: 1944Strictly equivalent to:
1851 1945
1852 IO::AIO::poll_wait, IO::AIO::poll_cb 1946 IO::AIO::poll_wait, IO::AIO::poll_cb
1853 while IO::AIO::nreqs; 1947 while IO::AIO::nreqs;
1854 1948
1949This function can be useful at program aborts, to make sure outstanding
1950I/O has been done (C<IO::AIO> uses an C<END> block which already calls
1951this function on normal exits), or when you are merely using C<IO::AIO>
1952for its more advanced functions, rather than for async I/O, e.g.:
1953
1954 my ($dirs, $nondirs);
1955 IO::AIO::aio_scandir "/tmp", 0, sub { ($dirs, $nondirs) = @_ };
1956 IO::AIO::flush;
1957 # $dirs, $nondirs are now set
1958
1855=item IO::AIO::max_poll_reqs $nreqs 1959=item IO::AIO::max_poll_reqs $nreqs
1856 1960
1857=item IO::AIO::max_poll_time $seconds 1961=item IO::AIO::max_poll_time $seconds
1858 1962
1859These set the maximum number of requests (default C<0>, meaning infinity) 1963These set the maximum number of requests (default C<0>, meaning infinity)
… …
1885 poll => 'r', nice => 1, 1989 poll => 'r', nice => 1,
1886 cb => &IO::AIO::poll_cb); 1990 cb => &IO::AIO::poll_cb);
1887 1991
1888=back 1992=back
1889 1993
1994
1890=head3 CONTROLLING THE NUMBER OF THREADS 1995=head3 CONTROLLING THE NUMBER OF THREADS
1891 1996
1892=over 1997=over
1893 1998
1894=item IO::AIO::min_parallel $nthreads 1999=item IO::AIO::min_parallel $nthreads
… …
1960This is a very bad function to use in interactive programs because it 2065This is a very bad function to use in interactive programs because it
1961blocks, and a bad way to reduce concurrency because it is inexact: Better 2066blocks, and a bad way to reduce concurrency because it is inexact: Better
1962use an C<aio_group> together with a feed callback. 2067use an C<aio_group> together with a feed callback.
1963 2068
1964Its main use is in scripts without an event loop - when you want to stat 2069Its main use is in scripts without an event loop - when you want to stat
1965a lot of files, you can write somehting like this: 2070a lot of files, you can write something like this:
1966 2071
1967 IO::AIO::max_outstanding 32; 2072 IO::AIO::max_outstanding 32;
1968 2073
1969 for my $path (...) { 2074 for my $path (...) {
1970 aio_stat $path , ...; 2075 aio_stat $path , ...;
… …
1981The default value for C<max_outstanding> is very large, so there is no 2086The default value for C<max_outstanding> is very large, so there is no
1982practical limit on the number of outstanding requests. 2087practical limit on the number of outstanding requests.
1983 2088
1984=back 2089=back
1985 2090
2091
1986=head3 STATISTICAL INFORMATION 2092=head3 STATISTICAL INFORMATION
1987 2093
1988=over 2094=over
1989 2095
1990=item IO::AIO::nreqs 2096=item IO::AIO::nreqs
… …
2006 2112
2007Returns the number of requests currently in the pending state (executed, 2113Returns the number of requests currently in the pending state (executed,
2008but not yet processed by poll_cb). 2114but not yet processed by poll_cb).
2009 2115
2010=back 2116=back
2117
2118
2119=head3 SUBSECOND STAT TIME ACCESS
2120
2121Both C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> functions can
2122generally find access/modification and change times with subsecond time
2123accuracy of the system supports it, but perl's built-in functions only
2124return the integer part.
2125
2126The following functions return the timestamps of the most recent
2127stat with subsecond precision on most systems and work both after
2128C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> calls. Their return
2129value is only meaningful after a successful C<stat>/C<lstat> call, or
2130during/after a successful C<aio_stat>/C<aio_lstat> callback.
2131
2132This is similar to the L<Time::HiRes> C<stat> functions, but can return
2133full resolution without rounding and work with standard perl C<stat>,
2134alleviating the need to call the special C<Time::HiRes> functions, which
2135do not act like their perl counterparts.
2136
2137On operating systems or file systems where subsecond time resolution is
2138not supported or could not be detected, a fractional part of C<0> is
2139returned, so it is always safe to call these functions.
2140
2141=over 4
2142
2143=item $seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime, IO::AIO::st_btime
2144
2145Return the access, modication, change or birth time, respectively,
2146including fractional part. Due to the limited precision of floating point,
2147the accuracy on most platforms is only a bit better than milliseconds
2148for times around now - see the I<nsec> function family, below, for full
2149accuracy.
2150
2151File birth time is only available when the OS and perl support it (on
2152FreeBSD and NetBSD at the time of this writing, although support is
2153adaptive, so if your OS/perl gains support, IO::AIO can take advantage of
2154it). On systems where it isn't available, C<0> is currently returned, but
2155this might change to C<undef> in a future version.
2156
2157=item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime
2158
2159Returns access, modification, change and birth time all in one go, and
2160maybe more times in the future version.
2161
2162=item $nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, IO::AIO::st_ctimensec, IO::AIO::st_btimensec
2163
2164Return the fractional access, modifcation, change or birth time, in nanoseconds,
2165as an integer in the range C<0> to C<999999999>.
2166
2167Note that no accessors are provided for access, modification and
2168change times - you need to get those from C<stat _> if required (C<int
2169IO::AIO::st_atime> and so on will I<not> generally give you the correct
2170value).
2171
2172=item $seconds = IO::AIO::st_btimesec
2173
2174The (integral) seconds part of the file birth time, if available.
2175
2176=item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtimensec
2177
2178Like the functions above, but returns all four times in one go (and maybe
2179more in future versions).
2180
2181=item $counter = IO::AIO::st_gen
2182
2183Returns the generation counter (in practice this is just a random number)
2184of the file. This is only available on platforms which have this member in
2185their C<struct stat> (most BSDs at the time of this writing) and generally
2186only to the root usert. If unsupported, C<0> is returned, but this might
2187change to C<undef> in a future version.
2188
2189=back
2190
2191Example: print the high resolution modification time of F</etc>, using
2192C<stat>, and C<IO::AIO::aio_stat>.
2193
2194 if (stat "/etc") {
2195 printf "stat(/etc) mtime: %f\n", IO::AIO::st_mtime;
2196 }
2197
2198 IO::AIO::aio_stat "/etc", sub {
2199 $_[0]
2200 and return;
2201
2202 printf "aio_stat(/etc) mtime: %d.%09d\n", (stat _)[9], IO::AIO::st_mtimensec;
2203 };
2204
2205 IO::AIO::flush;
2206
2207Output of the awbove on my system, showing reduced and full accuracy:
2208
2209 stat(/etc) mtime: 1534043702.020808
2210 aio_stat(/etc) mtime: 1534043702.020807792
2211
2011 2212
2012=head3 MISCELLANEOUS FUNCTIONS 2213=head3 MISCELLANEOUS FUNCTIONS
2013 2214
2014IO::AIO implements some functions that are useful when you want to use 2215IO::AIO implements some functions that are useful when you want to use
2015some "Advanced I/O" function not available to in Perl, without going the 2216some "Advanced I/O" function not available to in Perl, without going the
2016"Asynchronous I/O" route. Many of these have an asynchronous C<aio_*> 2217"Asynchronous I/O" route. Many of these have an asynchronous C<aio_*>
2017counterpart. 2218counterpart.
2018 2219
2019=over 4 2220=over 4
2221
2222=item $numfd = IO::AIO::get_fdlimit
2223
2224This function is I<EXPERIMENTAL> and subject to change.
2225
2226Tries to find the current file descriptor limit and returns it, or
2227C<undef> and sets C<$!> in case of an error. The limit is one larger than
2228the highest valid file descriptor number.
2229
2230=item IO::AIO::min_fdlimit [$numfd]
2231
2232This function is I<EXPERIMENTAL> and subject to change.
2233
2234Try to increase the current file descriptor limit(s) to at least C<$numfd>
2235by changing the soft or hard file descriptor resource limit. If C<$numfd>
2236is missing, it will try to set a very high limit, although this is not
2237recommended when you know the actual minimum that you require.
2238
2239If the limit cannot be raised enough, the function makes a best-effort
2240attempt to increase the limit as much as possible, using various
2241tricks, while still failing. You can query the resulting limit using
2242C<IO::AIO::get_fdlimit>.
2243
2244If an error occurs, returns C<undef> and sets C<$!>, otherwise returns
2245true.
2020 2246
2021=item IO::AIO::sendfile $ofh, $ifh, $offset, $count 2247=item IO::AIO::sendfile $ofh, $ifh, $offset, $count
2022 2248
2023Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>, 2249Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>,
2024but is blocking (this makes most sense if you know the input data is 2250but is blocking (this makes most sense if you know the input data is
… …
2041=item IO::AIO::madvise $scalar, $offset, $len, $advice 2267=item IO::AIO::madvise $scalar, $offset, $len, $advice
2042 2268
2043Simply calls the C<posix_madvise> function (see its 2269Simply calls the C<posix_madvise> function (see its
2044manpage for details). The following advice constants are 2270manpage for details). The following advice constants are
2045available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, 2271available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
2046C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>. 2272C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>,
2273C<IO::AIO::MADV_DONTNEED>.
2274
2275If C<$offset> is negative, counts from the end. If C<$length> is negative,
2276the remaining length of the C<$scalar> is used. If possible, C<$length>
2277will be reduced to fit into the C<$scalar>.
2047 2278
2048On systems that do not implement C<posix_madvise>, this function returns 2279On systems that do not implement C<posix_madvise>, this function returns
2049ENOSYS, otherwise the return value of C<posix_madvise>. 2280ENOSYS, otherwise the return value of C<posix_madvise>.
2050 2281
2051=item IO::AIO::mprotect $scalar, $offset, $len, $protect 2282=item IO::AIO::mprotect $scalar, $offset, $len, $protect
… …
2053Simply calls the C<mprotect> function on the preferably AIO::mmap'ed 2284Simply calls the C<mprotect> function on the preferably AIO::mmap'ed
2054$scalar (see its manpage for details). The following protect 2285$scalar (see its manpage for details). The following protect
2055constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>, 2286constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,
2056C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>. 2287C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.
2057 2288
2289If C<$offset> is negative, counts from the end. If C<$length> is negative,
2290the remaining length of the C<$scalar> is used. If possible, C<$length>
2291will be reduced to fit into the C<$scalar>.
2292
2058On systems that do not implement C<mprotect>, this function returns 2293On systems that do not implement C<mprotect>, this function returns
2059ENOSYS, otherwise the return value of C<mprotect>. 2294ENOSYS, otherwise the return value of C<mprotect>.
2060 2295
2061=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] 2296=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
2062 2297
2063Memory-maps a file (or anonymous memory range) and attaches it to the 2298Memory-maps a file (or anonymous memory range) and attaches it to the
2064given C<$scalar>, which will act like a string scalar. Returns true on 2299given C<$scalar>, which will act like a string scalar. Returns true on
2065success, and false otherwise. 2300success, and false otherwise.
2066 2301
2302The scalar must exist, but its contents do not matter - this means you
2303cannot use a nonexistant array or hash element. When in doubt, C<undef>
2304the scalar first.
2305
2067The only operations allowed on the scalar are C<substr>/C<vec> that don't 2306The only operations allowed on the mmapped scalar are C<substr>/C<vec>,
2068change the string length, and most read-only operations such as copying it 2307which don't change the string length, and most read-only operations such
2069or searching it with regexes and so on. 2308as copying it or searching it with regexes and so on.
2070 2309
2071Anything else is unsafe and will, at best, result in memory leaks. 2310Anything else is unsafe and will, at best, result in memory leaks.
2072 2311
2073The memory map associated with the C<$scalar> is automatically removed 2312The memory map associated with the C<$scalar> is automatically removed
2074when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or 2313when the C<$scalar> is undef'd or destroyed, or when the C<IO::AIO::mmap>
2075C<IO::AIO::munmap> functions are called. 2314or C<IO::AIO::munmap> functions are called on it.
2076 2315
2077This calls the C<mmap>(2) function internally. See your system's manual 2316This calls the C<mmap>(2) function internally. See your system's manual
2078page for details on the C<$length>, C<$prot> and C<$flags> parameters. 2317page for details on the C<$length>, C<$prot> and C<$flags> parameters.
2079 2318
2080The C<$length> must be larger than zero and smaller than the actual 2319The C<$length> must be larger than zero and smaller than the actual
… …
2118 2357
2119=item IO::AIO::munmap $scalar 2358=item IO::AIO::munmap $scalar
2120 2359
2121Removes a previous mmap and undefines the C<$scalar>. 2360Removes a previous mmap and undefines the C<$scalar>.
2122 2361
2362=item IO::AIO::mremap $scalar, $new_length, $flags = MREMAP_MAYMOVE[, $new_address = 0]
2363
2364Calls the Linux-specific mremap(2) system call. The C<$scalar> must have
2365been mapped by C<IO::AIO::mmap>, and C<$flags> must currently either be
2366C<0> or C<IO::AIO::MREMAP_MAYMOVE>.
2367
2368Returns true if successful, and false otherwise. If the underlying mmapped
2369region has changed address, then the true value has the numerical value
2370C<1>, otherwise it has the numerical value C<0>:
2371
2372 my $success = IO::AIO::mremap $mmapped, 8192, IO::AIO::MREMAP_MAYMOVE
2373 or die "mremap: $!";
2374
2375 if ($success*1) {
2376 warn "scalar has chanegd address in memory\n";
2377 }
2378
2379C<IO::AIO::MREMAP_FIXED> and the C<$new_address> argument are currently
2380implemented, but not supported and might go away in a future version.
2381
2382On systems where this call is not supported or is not emulated, this call
2383returns falls and sets C<$!> to C<ENOSYS>.
2384
2385=item IO::AIO::mlockall $flags
2386
2387Calls the C<eio_mlockall_sync> function, which is like C<aio_mlockall>,
2388but is blocking.
2389
2123=item IO::AIO::munlock $scalar, $offset = 0, $length = undef 2390=item IO::AIO::munlock $scalar, $offset = 0, $length = undef
2124 2391
2125Calls the C<munlock> function, undoing the effects of a previous 2392Calls the C<munlock> function, undoing the effects of a previous
2126C<aio_mlock> call (see its description for details). 2393C<aio_mlock> call (see its description for details).
2127 2394
… …
2176C<$flags> is non-zero, fails with C<ENOSYS>. 2443C<$flags> is non-zero, fails with C<ENOSYS>.
2177 2444
2178Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the 2445Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the
2179time of this writing, C<IO::AIO::O_CLOEXEC>, C<IO::AIO::O_NONBLOCK> and 2446time of this writing, C<IO::AIO::O_CLOEXEC>, C<IO::AIO::O_NONBLOCK> and
2180C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported. 2447C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported.
2448
2449Example: create a pipe race-free w.r.t. threads and fork:
2450
2451 my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC
2452 or die "pipe2: $!\n";
2453
2454=item $fh = IO::AIO::memfd_create $pathname[, $flags]
2455
2456This is a direct interface to the Linux L<memfd_create(2)> system
2457call. The (unhelpful) default for C<$flags> is C<0>, but your default
2458should be C<IO::AIO::MFD_CLOEXEC>.
2459
2460On success, the new memfd filehandle is returned, otherwise returns
2461C<undef>. If the memfd_create syscall is missing, fails with C<ENOSYS>.
2462
2463Please refer to L<memfd_create(2)> for more info on this call.
2464
2465The following C<$flags> values are available: C<IO::AIO::MFD_CLOEXEC>,
2466C<IO::AIO::MFD_ALLOW_SEALING> and C<IO::AIO::MFD_HUGETLB>.
2467
2468Example: create a new memfd.
2469
2470 my $fh = IO::AIO::memfd_create "somenameforprocfd", IO::AIO::MFD_CLOEXEC
2471 or die "m,emfd_create: $!\n";
2472=item $fh = IO::AIO::eventfd [$initval, [$flags]]
2473
2474This is a direct interface to the Linux L<eventfd(2)> system call. The
2475(unhelpful) defaults for C<$initval> and C<$flags> are C<0> for both.
2476
2477On success, the new eventfd filehandle is returned, otherwise returns
2478C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>.
2479
2480Please refer to L<eventfd(2)> for more info on this call.
2481
2482The following symbol flag values are available: C<IO::AIO::EFD_CLOEXEC>,
2483C<IO::AIO::EFD_NONBLOCK> and C<IO::AIO::EFD_SEMAPHORE> (Linux 2.6.30).
2484
2485Example: create a new eventfd filehandle:
2486
2487 $fh = IO::AIO::eventfd 0, IO::AIO::EFD_CLOEXEC
2488 or die "eventfd: $!\n";
2489
2490=item $fh = IO::AIO::timerfd_create $clockid[, $flags]
2491
2492This is a direct interface to the Linux L<timerfd_create(2)> system
2493call. The (unhelpful) default for C<$flags> is C<0>, but your default
2494should be C<IO::AIO::TFD_CLOEXEC>.
2495
2496On success, the new timerfd filehandle is returned, otherwise returns
2497C<undef>. If the timerfd_create syscall is missing, fails with C<ENOSYS>.
2498
2499Please refer to L<timerfd_create(2)> for more info on this call.
2500
2501The following C<$clockid> values are
2502available: C<IO::AIO::CLOCK_REALTIME>, C<IO::AIO::CLOCK_MONOTONIC>
2503C<IO::AIO::CLOCK_CLOCK_BOOTTIME> (Linux 3.15)
2504C<IO::AIO::CLOCK_CLOCK_REALTIME_ALARM> (Linux 3.11) and
2505C<IO::AIO::CLOCK_CLOCK_BOOTTIME_ALARM> (Linux 3.11).
2506
2507The following C<$flags> values are available (Linux
25082.6.27): C<IO::AIO::TFD_NONBLOCK> and C<IO::AIO::TFD_CLOEXEC>.
2509
2510Example: create a new timerfd and set it to one-second repeated alarms,
2511then wait for two alarms:
2512
2513 my $fh = IO::AIO::timerfd_create IO::AIO::CLOCK_BOOTTIME, IO::AIO::TFD_CLOEXEC
2514 or die "timerfd_create: $!\n";
2515
2516 defined IO::AIO::timerfd_settime $fh, 0, 1, 1
2517 or die "timerfd_settime: $!\n";
2518
2519 for (1..2) {
2520 8 == sysread $fh, my $buf, 8
2521 or die "timerfd read failure\n";
2522
2523 printf "number of expirations (likely 1): %d\n",
2524 unpack "Q", $buf;
2525 }
2526
2527=item ($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags, $new_interval, $nbw_value
2528
2529This is a direct interface to the Linux L<timerfd_settime(2)> system
2530call. Please refer to its manpage for more info on this call.
2531
2532The new itimerspec is specified using two (possibly fractional) second
2533values, C<$new_interval> and C<$new_value>).
2534
2535On success, the current interval and value are returned (as per
2536C<timerfd_gettime>). On failure, the empty list is returned.
2537
2538The following C<$flags> values are
2539available: C<IO::AIO::TFD_TIMER_ABSTIME> and
2540C<IO::AIO::TFD_TIMER_CANCEL_ON_SET>.
2541
2542See C<IO::AIO::timerfd_create> for a full example.
2543
2544=item ($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh
2545
2546This is a direct interface to the Linux L<timerfd_gettime(2)> system
2547call. Please refer to its manpage for more info on this call.
2548
2549On success, returns the current values of interval and value for the given
2550timerfd (as potentially fractional second values). On failure, the empty
2551list is returned.
2181 2552
2182=back 2553=back
2183 2554
2184=cut 2555=cut
2185 2556
… …
2251the process will result in undefined behaviour. Calling it at any time 2622the process will result in undefined behaviour. Calling it at any time
2252will also result in any undefined (by POSIX) behaviour. 2623will also result in any undefined (by POSIX) behaviour.
2253 2624
2254=back 2625=back
2255 2626
2627=head2 LINUX-SPECIFIC CALLS
2628
2629When a call is documented as "linux-specific" then this means it
2630originated on GNU/Linux. C<IO::AIO> will usually try to autodetect the
2631availability and compatibility of such calls regardless of the platform
2632it is compiled on, so platforms such as FreeBSD which often implement
2633these calls will work. When in doubt, call them and see if they fail wth
2634C<ENOSYS>.
2635
2256=head2 MEMORY USAGE 2636=head2 MEMORY USAGE
2257 2637
2258Per-request usage: 2638Per-request usage:
2259 2639
2260Each aio request uses - depending on your architecture - around 100-200 2640Each aio request uses - depending on your architecture - around 100-200
… …
2272temporary buffers, and each thread requires a stack and other data 2652temporary buffers, and each thread requires a stack and other data
2273structures (usually around 16k-128k, depending on the OS). 2653structures (usually around 16k-128k, depending on the OS).
2274 2654
2275=head1 KNOWN BUGS 2655=head1 KNOWN BUGS
2276 2656
2277Known bugs will be fixed in the next release. 2657Known bugs will be fixed in the next release :)
2658
2659=head1 KNOWN ISSUES
2660
2661Calls that try to "import" foreign memory areas (such as C<IO::AIO::mmap>
2662or C<IO::AIO::aio_slurp>) do not work with generic lvalues, such as
2663non-created hash slots or other scalars I didn't think of. It's best to
2664avoid such and either use scalar variables or making sure that the scalar
2665exists (e.g. by storing C<undef>) and isn't "funny" (e.g. tied).
2666
2667I am not sure anything can be done about this, so this is considered a
2668known issue, rather than a bug.
2278 2669
2279=head1 SEE ALSO 2670=head1 SEE ALSO
2280 2671
2281L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a 2672L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
2282more natural syntax. 2673more natural syntax and L<IO::FDPass> for file descriptor passing.
2283 2674
2284=head1 AUTHOR 2675=head1 AUTHOR
2285 2676
2286 Marc Lehmann <schmorp@schmorp.de> 2677 Marc Lehmann <schmorp@schmorp.de>
2287 http://home.schmorp.de/ 2678 http://home.schmorp.de/

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines