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.264 by root, Mon Jul 18 07:48:01 2016 UTC vs.
Revision 1.312 by root, Tue Jul 27 18:46:06 2021 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.76;
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
286 IO::AIO::min_fdlimit $nfd
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::accept4 $r_fh, $sockaddr, $sockaddr_len, $flags
309 IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
310 IO::AIO::tee $r_fh, $w_fh, $length, $flags
311 $actual_size = IO::AIO::pipesize $r_fh[, $new_size]
312 ($rfh, $wfh) = IO::AIO::pipe2 [$flags]
313 $fh = IO::AIO::memfd_create $pathname[, $flags]
314 $fh = IO::AIO::eventfd [$initval, [$flags]]
315 $fh = IO::AIO::timerfd_create $clockid[, $flags]
316 ($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags, $new_interval, $nbw_value
317 ($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh
286 318
287=head2 API NOTES 319=head2 API NOTES
288 320
289All the C<aio_*> calls are more or less thin wrappers around the syscall 321All 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, 322with the same name (sans C<aio_>). The arguments are similar or identical,
396following POSIX and non-POSIX constants are available (missing ones on 428following POSIX and non-POSIX constants are available (missing ones on
397your system are, as usual, C<0>): 429your system are, as usual, C<0>):
398 430
399C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>, 431C<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>, 432C<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>. 433C<O_RSYNC>, C<O_SYNC>, C<O_PATH>, C<O_TMPFILE>, C<O_TTY_INIT> and C<O_ACCMODE>.
402 434
403 435
404=item aio_close $fh, $callback->($status) 436=item aio_close $fh, $callback->($status)
405 437
406Asynchronously close a file and call the callback with the result 438Asynchronously close a file and call the callback with the result
441=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 473=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
442 474
443=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 475=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
444 476
445Reads or writes C<$length> bytes from or to the specified C<$fh> and 477Reads 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> 478C<$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 479calls the callback with the actual number of bytes transferred (or -1 on
448error, just like the syscall). 480error, just like the syscall).
449 481
450C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to 482C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to
451offset plus the actual number of bytes read. 483offset plus the actual number of bytes read.
452 484
532 564
533=item aio_stat $fh_or_path, $callback->($status) 565=item aio_stat $fh_or_path, $callback->($status)
534 566
535=item aio_lstat $fh, $callback->($status) 567=item aio_lstat $fh, $callback->($status)
536 568
537Works like perl's C<stat> or C<lstat> in void context. The callback will 569Works 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 _> 570callback will be called after the stat and the results will be available
539or C<-s _> etc... 571using C<stat _> or C<-s _> and other tests (with the exception of C<-B>
572and C<-T>).
540 573
541The pathname passed to C<aio_stat> must be absolute. See API NOTES, above, 574The pathname passed to C<aio_stat> must be absolute. See API NOTES, above,
542for an explanation. 575for an explanation.
543 576
544Currently, the stats are always 64-bit-stats, i.e. instead of returning an 577Currently, the stats are always 64-bit-stats, i.e. instead of returning an
551behaviour). 584behaviour).
552 585
553C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>, 586C<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>, 587C<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>. 588C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>.
589
590To access higher resolution stat timestamps, see L<SUBSECOND STAT TIME
591ACCESS>.
556 592
557Example: Print the length of F</etc/passwd>: 593Example: Print the length of F</etc/passwd>:
558 594
559 aio_stat "/etc/passwd", sub { 595 aio_stat "/etc/passwd", sub {
560 $_[0] and die "stat failed: $!"; 596 $_[0] and die "stat failed: $!";
604 namemax => 255, 640 namemax => 255,
605 frsize => 1024, 641 frsize => 1024,
606 fsid => 1810 642 fsid => 1810
607 } 643 }
608 644
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) 645=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
695 646
696Works like perl's C<utime> function (including the special case of $atime 647Works like perl's C<utime> function (including the special case of $atime
697and $mtime being undef). Fractional times are supported if the underlying 648and $mtime being undef). Fractional times are supported if the underlying
698syscalls support them. 649syscalls support them.
699 650
700When called with a pathname, uses utimes(2) if available, otherwise 651When 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, 652otherwise utime(2). If called on a file descriptor, uses futimens(2)
702otherwise returns ENOSYS, so this is not portable. 653or futimes(2) if available, otherwise returns ENOSYS, so this is not
654portable.
703 655
704Examples: 656Examples:
705 657
706 # set atime and mtime to current time (basically touch(1)): 658 # set atime and mtime to current time (basically touch(1)):
707 aio_utime "path", undef, undef; 659 aio_utime "path", undef, undef;
735C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate 687C<$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>, 688space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE | IO::AIO::FALLOC_FL_KEEP_SIZE>,
737to deallocate a file range. 689to deallocate a file range.
738 690
739IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range 691IO::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 692(without leaving a hole), C<FALLOC_FL_ZERO_RANGE>, to zero a range,
741your L<fallocate(2)> manpage). 693C<FALLOC_FL_INSERT_RANGE> to insert a range and C<FALLOC_FL_UNSHARE_RANGE>
694to unshare shared blocks (see your L<fallocate(2)> manpage).
742 695
743The file system block size used by C<fallocate> is presumably the 696The file system block size used by C<fallocate> is presumably the
744C<f_bsize> returned by C<statvfs>. 697C<f_bsize> returned by C<statvfs>, but different filesystems and filetypes
698can dictate other limitations.
745 699
746If C<fallocate> isn't available or cannot be emulated (currently no 700If C<fallocate> isn't available or cannot be emulated (currently no
747emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>. 701emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>.
748 702
749 703
808On systems that support the AIO::WD working directory abstraction 762On systems that support the AIO::WD working directory abstraction
809natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead 763natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead
810of failing, C<rename> is called on the absolute path of C<$wd>. 764of failing, C<rename> is called on the absolute path of C<$wd>.
811 765
812 766
767=item aio_rename2 $srcpath, $dstpath, $flags, $callback->($status)
768
769Basically a version of C<aio_rename> with an additional C<$flags>
770argument. Calling this with C<$flags=0> is the same as calling
771C<aio_rename>.
772
773Non-zero flags are currently only supported on GNU/Linux systems that
774support renameat2. Other systems fail with C<ENOSYS> in this case.
775
776The following constants are available (missing ones are, as usual C<0>),
777see renameat2(2) for details:
778
779C<IO::AIO::RENAME_NOREPLACE>, C<IO::AIO::RENAME_EXCHANGE>
780and C<IO::AIO::RENAME_WHITEOUT>.
781
782
813=item aio_mkdir $pathname, $mode, $callback->($status) 783=item aio_mkdir $pathname, $mode, $callback->($status)
814 784
815Asynchronously mkdir (create) a directory and call the callback with 785Asynchronously mkdir (create) a directory and call the callback with
816the result code. C<$mode> will be modified by the umask at the time the 786the result code. C<$mode> will be modified by the umask at the time the
817request is executed, so do not change your umask. 787request is executed, so do not change your umask.
848 818
849=over 4 819=over 4
850 820
851=item IO::AIO::READDIR_DENTS 821=item IO::AIO::READDIR_DENTS
852 822
853When this flag is off, then the callback gets an arrayref consisting of 823Normally the callback gets an arrayref consisting of names only (as
854names only (as with C<aio_readdir>), otherwise it gets an arrayref with 824with C<aio_readdir>). If this flag is set, then the callback gets an
855C<[$name, $type, $inode]> arrayrefs, each describing a single directory 825arrayref with C<[$name, $type, $inode]> arrayrefs, each describing a
856entry in more detail. 826single directory entry in more detail:
857 827
858C<$name> is the name of the entry. 828C<$name> is the name of the entry.
859 829
860C<$type> is one of the C<IO::AIO::DT_xxx> constants: 830C<$type> is one of the C<IO::AIO::DT_xxx> constants:
861 831
862C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>, 832C<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>, 833C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>,
864C<IO::AIO::DT_WHT>. 834C<IO::AIO::DT_WHT>.
865 835
866C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to 836C<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> 837to know, you have to run stat yourself. Also, for speed/memory reasons,
868scalars are read-only: you can not modify them. 838the C<$type> scalars are read-only: you must not modify them.
869 839
870C<$inode> is the inode number (which might not be exact on systems with 64 840C<$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 841bit inode numbers and 32 bit perls). This field has unspecified content on
872systems that do not deliver the inode information. 842systems that do not deliver the inode information.
873 843
884short names are tried first. 854short names are tried first.
885 855
886=item IO::AIO::READDIR_STAT_ORDER 856=item IO::AIO::READDIR_STAT_ORDER
887 857
888When this flag is set, then the names will be returned in an order 858When 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() 859suitable 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 860all files in the given directory, then the returned order will likely be
891be fastest. 861faster.
892 862
893If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, then 863If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified,
894the likely dirs come first, resulting in a less optimal stat order. 864then the likely dirs come first, resulting in a less optimal stat order
865for stat'ing all entries, but likely a more optimal order for finding
866subdirectories.
895 867
896=item IO::AIO::READDIR_FOUND_UNKNOWN 868=item IO::AIO::READDIR_FOUND_UNKNOWN
897 869
898This flag should not be set when calling C<aio_readdirx>. Instead, it 870This 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 871is 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. 873C<$type>'s are known, which can be used to speed up some algorithms.
902 874
903=back 875=back
904 876
905 877
878=item aio_slurp $pathname, $offset, $length, $data, $callback->($status)
879
880Opens, reads and closes the given file. The data is put into C<$data>,
881which is resized as required.
882
883If C<$offset> is negative, then it is counted from the end of the file.
884
885If C<$length> is zero, then the remaining length of the file is
886used. Also, in this case, the same limitations to modifying C<$data> apply
887as when IO::AIO::mmap is used, i.e. it must only be modified in-place
888with C<substr>. If the size of the file is known, specifying a non-zero
889C<$length> results in a performance advantage.
890
891This request is similar to the older C<aio_load> request, but since it is
892a single request, it might be more efficient to use.
893
894Example: load F</etc/passwd> into C<$passwd>.
895
896 my $passwd;
897 aio_slurp "/etc/passwd", 0, 0, $passwd, sub {
898 $_[0] >= 0
899 or die "/etc/passwd: $!\n";
900
901 printf "/etc/passwd is %d bytes long, and contains:\n", length $passwd;
902 print $passwd;
903 };
904 IO::AIO::flush;
905
906
906=item aio_load $pathname, $data, $callback->($status) 907=item aio_load $pathname, $data, $callback->($status)
907 908
908This is a composite request that tries to fully load the given file into 909This is a composite request that tries to fully load the given file into
909memory. Status is the same as with aio_read. 910memory. Status is the same as with aio_read.
911
912Using C<aio_slurp> might be more efficient, as it is a single request.
910 913
911=cut 914=cut
912 915
913sub aio_load($$;$) { 916sub aio_load($$;$) {
914 my ($path, undef, $cb) = @_; 917 my ($path, undef, $cb) = @_;
934=item aio_copy $srcpath, $dstpath, $callback->($status) 937=item aio_copy $srcpath, $dstpath, $callback->($status)
935 938
936Try to copy the I<file> (directories not supported as either source or 939Try to copy the I<file> (directories not supported as either source or
937destination) from C<$srcpath> to C<$dstpath> and call the callback with 940destination) from C<$srcpath> to C<$dstpath> and call the callback with
938a status of C<0> (ok) or C<-1> (error, see C<$!>). 941a status of C<0> (ok) or C<-1> (error, see C<$!>).
942
943Existing destination files will be truncated.
939 944
940This is a composite request that creates the destination file with 945This is a composite request that creates the destination file with
941mode 0200 and copies the contents of the source file into it using 946mode 0200 and copies the contents of the source file into it using
942C<aio_sendfile>, followed by restoring atime, mtime, access mode and 947C<aio_sendfile>, followed by restoring atime, mtime, access mode and
943uid/gid, in that order. 948uid/gid, in that order.
1053Scans a directory (similar to C<aio_readdir>) but additionally tries to 1058Scans a directory (similar to C<aio_readdir>) but additionally tries to
1054efficiently separate the entries of directory C<$path> into two sets of 1059efficiently separate the entries of directory C<$path> into two sets of
1055names, directories you can recurse into (directories), and ones you cannot 1060names, directories you can recurse into (directories), and ones you cannot
1056recurse into (everything else, including symlinks to directories). 1061recurse into (everything else, including symlinks to directories).
1057 1062
1058C<aio_scandir> is a composite request that creates of many sub requests_ 1063C<aio_scandir> is a composite request that generates many sub requests.
1059C<$maxreq> specifies the maximum number of outstanding aio requests that 1064C<$maxreq> specifies the maximum number of outstanding aio requests that
1060this function generates. If it is C<< <= 0 >>, then a suitable default 1065this function generates. If it is C<< <= 0 >>, then a suitable default
1061will be chosen (currently 4). 1066will be chosen (currently 4).
1062 1067
1063On error, the callback is called without arguments, otherwise it receives 1068On error, the callback is called without arguments, otherwise it receives
1127 aioreq_pri $pri; 1132 aioreq_pri $pri;
1128 add $grp aio_stat $wd, sub { 1133 add $grp aio_stat $wd, sub {
1129 return $grp->result () if $_[0]; 1134 return $grp->result () if $_[0];
1130 my $now = time; 1135 my $now = time;
1131 my $hash1 = join ":", (stat _)[0,1,3,7,9]; 1136 my $hash1 = join ":", (stat _)[0,1,3,7,9];
1137 my $rdxflags = READDIR_DIRS_FIRST;
1138
1139 if ((stat _)[3] < 2) {
1140 # at least one non-POSIX filesystem exists
1141 # that returns useful DT_type values: btrfs,
1142 # so optimise for this here by requesting dents
1143 $rdxflags |= READDIR_DENTS;
1144 }
1132 1145
1133 # read the directory entries 1146 # read the directory entries
1134 aioreq_pri $pri; 1147 aioreq_pri $pri;
1135 add $grp aio_readdirx $wd, READDIR_DIRS_FIRST, sub { 1148 add $grp aio_readdirx $wd, $rdxflags, sub {
1136 my $entries = shift 1149 my ($entries, $flags) = @_
1137 or return $grp->result (); 1150 or return $grp->result ();
1151
1152 if ($rdxflags & READDIR_DENTS) {
1153 # if we requested type values, see if we can use them directly.
1154
1155 # if there were any DT_UNKNOWN entries then we assume we
1156 # don't know. alternatively, we could assume that if we get
1157 # one DT_DIR, then all directories are indeed marked with
1158 # DT_DIR, but this seems not required for btrfs, and this
1159 # is basically the "btrfs can't get it's act together" code
1160 # branch.
1161 unless ($flags & READDIR_FOUND_UNKNOWN) {
1162 # now we have valid DT_ information for all entries,
1163 # so use it as an optimisation without further stat's.
1164 # they must also all be at the beginning of @$entries
1165 # by now.
1166
1167 my $dirs;
1168
1169 if (@$entries) {
1170 for (0 .. $#$entries) {
1171 if ($entries->[$_][1] != DT_DIR) {
1172 # splice out directories
1173 $dirs = [splice @$entries, 0, $_];
1174 last;
1175 }
1176 }
1177
1178 # if we didn't find any non-dir, then all entries are dirs
1179 unless ($dirs) {
1180 ($dirs, $entries) = ($entries, []);
1181 }
1182 } else {
1183 # directory is empty, so there are no sbdirs
1184 $dirs = [];
1185 }
1186
1187 # either splice'd the directories out or the dir was empty.
1188 # convert dents to filenames
1189 $_ = $_->[0] for @$dirs;
1190 $_ = $_->[0] for @$entries;
1191
1192 return $grp->result ($dirs, $entries);
1193 }
1194
1195 # cannot use, so return to our old ways
1196 # by pretending we only scanned for names.
1197 $_ = $_->[0] for @$entries;
1198 }
1138 1199
1139 # stat the dir another time 1200 # stat the dir another time
1140 aioreq_pri $pri; 1201 aioreq_pri $pri;
1141 add $grp aio_stat $wd, sub { 1202 add $grp aio_stat $wd, sub {
1142 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 1203 my $hash2 = join ":", (stat _)[0,1,3,7,9];
1248So in general, you should only use these calls for things that do 1309So 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, 1310(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, 1311other processes), although if you are careful and know what you are doing,
1251you still can. 1312you still can.
1252 1313
1253The following constants are available (missing ones are, as usual C<0>): 1314The following constants are available and can be used for normal C<ioctl>
1315and C<fcntl> as well (missing ones are, as usual C<0>):
1316
1317C<F_DUPFD_CLOEXEC>,
1318
1319C<F_OFD_GETLK>, C<F_OFD_SETLK>, C<F_OFD_GETLKW>,
1254 1320
1255C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>. 1321C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>.
1322
1323C<F_ADD_SEALS>, C<F_GET_SEALS>, C<F_SEAL_SEAL>, C<F_SEAL_SHRINK>, C<F_SEAL_GROW> and
1324C<F_SEAL_WRITE>.
1256 1325
1257C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>, 1326C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>,
1258C<FS_IOC_FIEMAP>. 1327C<FS_IOC_FIEMAP>.
1259 1328
1260C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>, 1329C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>,
1346 }; 1415 };
1347 1416
1348 $grp 1417 $grp
1349} 1418}
1350 1419
1351=item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 1420=item aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status)
1352 1421
1353This is a rather advanced IO::AIO call, which only works on mmap(2)ed 1422This is a rather advanced IO::AIO call, which only works on mmap(2)ed
1354scalars (see the C<IO::AIO::mmap> function, although it also works on data 1423scalars (see the C<IO::AIO::mmap> function, although it also works on data
1355scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the 1424scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the
1356scalar must only be modified in-place while an aio operation is pending on 1425scalar must only be modified in-place while an aio operation is pending on
1358 1427
1359It calls the C<msync> function of your OS, if available, with the memory 1428It calls the C<msync> function of your OS, if available, with the memory
1360area starting at C<$offset> in the string and ending C<$length> bytes 1429area starting at C<$offset> in the string and ending C<$length> bytes
1361later. If C<$length> is negative, counts from the end, and if C<$length> 1430later. If C<$length> is negative, counts from the end, and if C<$length>
1362is C<undef>, then it goes till the end of the string. The flags can be 1431is C<undef>, then it goes till the end of the string. The flags can be
1363a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and 1432either C<IO::AIO::MS_ASYNC> or C<IO::AIO::MS_SYNC>, plus an optional
1364C<IO::AIO::MS_SYNC>. 1433C<IO::AIO::MS_INVALIDATE>.
1365 1434
1366=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 1435=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
1367 1436
1368This is a rather advanced IO::AIO call, which works best on mmap(2)ed 1437This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1369scalars. 1438scalars.
1399 IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh; 1468 IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;
1400 aio_mlock $data; # mlock in background 1469 aio_mlock $data; # mlock in background
1401 1470
1402=item aio_mlockall $flags, $callback->($status) 1471=item aio_mlockall $flags, $callback->($status)
1403 1472
1404Calls the C<mlockall> function with the given C<$flags> (a combination of 1473Calls the C<mlockall> function with the given C<$flags> (a
1405C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>). 1474combination of C<IO::AIO::MCL_CURRENT>, C<IO::AIO::MCL_FUTURE> and
1475C<IO::AIO::MCL_ONFAULT>).
1406 1476
1407On systems that do not implement C<mlockall>, this function returns C<-1> 1477On systems that do not implement C<mlockall>, this function returns C<-1>
1408and sets errno to C<ENOSYS>. 1478and sets errno to C<ENOSYS>. Similarly, flag combinations not supported
1479by the system result in a return value of C<-1> with errno being set to
1480C<EINVAL>.
1409 1481
1410Note that the corresponding C<munlockall> is synchronous and is 1482Note that the corresponding C<munlockall> is synchronous and is
1411documented under L<MISCELLANEOUS FUNCTIONS>. 1483documented under L<MISCELLANEOUS FUNCTIONS>.
1412 1484
1413Example: asynchronously lock all current and future pages into memory. 1485Example: asynchronously lock all current and future pages into memory.
1452C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>, 1524C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,
1453C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>, 1525C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,
1454C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or 1526C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or
1455C<IO::AIO::FIEMAP_EXTENT_SHARED>. 1527C<IO::AIO::FIEMAP_EXTENT_SHARED>.
1456 1528
1457At the time of this writing (Linux 3.2), this requets is unreliable unless 1529At the time of this writing (Linux 3.2), this request is unreliable unless
1458C<$count> is C<undef>, as the kernel has all sorts of bugs preventing 1530C<$count> is C<undef>, as the kernel has all sorts of bugs preventing
1459it to return all extents of a range for files with large number of 1531it to return all extents of a range for files with a large number of
1460extents. The code works around all these issues if C<$count> is undef. 1532extents. The code (only) works around all these issues if C<$count> is
1533C<undef>.
1461 1534
1462=item aio_group $callback->(...) 1535=item aio_group $callback->(...)
1463 1536
1464This is a very special aio request: Instead of doing something, it is a 1537This is a very special aio request: Instead of doing something, it is a
1465container for other aio requests, which is useful if you want to bundle 1538container for other aio requests, which is useful if you want to bundle
1578There are some caveats: when directories get renamed (or deleted), the 1651There are some caveats: when directories get renamed (or deleted), the
1579pathname string doesn't change, so will point to the new directory (or 1652pathname string doesn't change, so will point to the new directory (or
1580nowhere at all), while the directory fd, if available on the system, 1653nowhere at all), while the directory fd, if available on the system,
1581will still point to the original directory. Most functions accepting a 1654will still point to the original directory. Most functions accepting a
1582pathname will use the directory fd on newer systems, and the string on 1655pathname will use the directory fd on newer systems, and the string on
1583older systems. Some functions (such as realpath) will always rely on the 1656older systems. Some functions (such as C<aio_realpath>) will always rely on
1584string form of the pathname. 1657the string form of the pathname.
1585 1658
1586So this functionality is mainly useful to get some protection against 1659So this functionality is mainly useful to get some protection against
1587C<chdir>, to easily get an absolute path out of a relative path for future 1660C<chdir>, to easily get an absolute path out of a relative path for future
1588reference, and to speed up doing many operations in the same directory 1661reference, and to speed up doing many operations in the same directory
1589(e.g. when stat'ing all files in a directory). 1662(e.g. when stat'ing all files in a directory).
1606C<aio_wd> callback, as future requests using the value will fail in the 1679C<aio_wd> callback, as future requests using the value will fail in the
1607expected way. 1680expected way.
1608 1681
1609=item IO::AIO::CWD 1682=item IO::AIO::CWD
1610 1683
1611This is a compiletime constant (object) that represents the process 1684This is a compile time constant (object) that represents the process
1612current working directory. 1685current working directory.
1613 1686
1614Specifying this object as working directory object for a pathname is as if 1687Specifying this object as working directory object for a pathname is as if
1615the pathname would be specified directly, without a directory object. For 1688the pathname would be specified directly, without a directory object. For
1616example, these calls are functionally identical: 1689example, these calls are functionally identical:
1797The default value for the limit is C<0>, but note that setting a feeder 1870The default value for the limit is C<0>, but note that setting a feeder
1798automatically bumps it up to C<2>. 1871automatically bumps it up to C<2>.
1799 1872
1800=back 1873=back
1801 1874
1875
1802=head2 SUPPORT FUNCTIONS 1876=head2 SUPPORT FUNCTIONS
1803 1877
1804=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION 1878=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
1805 1879
1806=over 4 1880=over 4
1871Strictly equivalent to: 1945Strictly equivalent to:
1872 1946
1873 IO::AIO::poll_wait, IO::AIO::poll_cb 1947 IO::AIO::poll_wait, IO::AIO::poll_cb
1874 while IO::AIO::nreqs; 1948 while IO::AIO::nreqs;
1875 1949
1950This function can be useful at program aborts, to make sure outstanding
1951I/O has been done (C<IO::AIO> uses an C<END> block which already calls
1952this function on normal exits), or when you are merely using C<IO::AIO>
1953for its more advanced functions, rather than for async I/O, e.g.:
1954
1955 my ($dirs, $nondirs);
1956 IO::AIO::aio_scandir "/tmp", 0, sub { ($dirs, $nondirs) = @_ };
1957 IO::AIO::flush;
1958 # $dirs, $nondirs are now set
1959
1876=item IO::AIO::max_poll_reqs $nreqs 1960=item IO::AIO::max_poll_reqs $nreqs
1877 1961
1878=item IO::AIO::max_poll_time $seconds 1962=item IO::AIO::max_poll_time $seconds
1879 1963
1880These set the maximum number of requests (default C<0>, meaning infinity) 1964These set the maximum number of requests (default C<0>, meaning infinity)
1906 poll => 'r', nice => 1, 1990 poll => 'r', nice => 1,
1907 cb => &IO::AIO::poll_cb); 1991 cb => &IO::AIO::poll_cb);
1908 1992
1909=back 1993=back
1910 1994
1995
1911=head3 CONTROLLING THE NUMBER OF THREADS 1996=head3 CONTROLLING THE NUMBER OF THREADS
1912 1997
1913=over 1998=over
1914 1999
1915=item IO::AIO::min_parallel $nthreads 2000=item IO::AIO::min_parallel $nthreads
1981This is a very bad function to use in interactive programs because it 2066This is a very bad function to use in interactive programs because it
1982blocks, and a bad way to reduce concurrency because it is inexact: Better 2067blocks, and a bad way to reduce concurrency because it is inexact: Better
1983use an C<aio_group> together with a feed callback. 2068use an C<aio_group> together with a feed callback.
1984 2069
1985Its main use is in scripts without an event loop - when you want to stat 2070Its main use is in scripts without an event loop - when you want to stat
1986a lot of files, you can write somehting like this: 2071a lot of files, you can write something like this:
1987 2072
1988 IO::AIO::max_outstanding 32; 2073 IO::AIO::max_outstanding 32;
1989 2074
1990 for my $path (...) { 2075 for my $path (...) {
1991 aio_stat $path , ...; 2076 aio_stat $path , ...;
2002The default value for C<max_outstanding> is very large, so there is no 2087The default value for C<max_outstanding> is very large, so there is no
2003practical limit on the number of outstanding requests. 2088practical limit on the number of outstanding requests.
2004 2089
2005=back 2090=back
2006 2091
2092
2007=head3 STATISTICAL INFORMATION 2093=head3 STATISTICAL INFORMATION
2008 2094
2009=over 2095=over
2010 2096
2011=item IO::AIO::nreqs 2097=item IO::AIO::nreqs
2027 2113
2028Returns the number of requests currently in the pending state (executed, 2114Returns the number of requests currently in the pending state (executed,
2029but not yet processed by poll_cb). 2115but not yet processed by poll_cb).
2030 2116
2031=back 2117=back
2118
2119
2120=head3 SUBSECOND STAT TIME ACCESS
2121
2122Both C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> functions can
2123generally find access/modification and change times with subsecond time
2124accuracy of the system supports it, but perl's built-in functions only
2125return the integer part.
2126
2127The following functions return the timestamps of the most recent
2128stat with subsecond precision on most systems and work both after
2129C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> calls. Their return
2130value is only meaningful after a successful C<stat>/C<lstat> call, or
2131during/after a successful C<aio_stat>/C<aio_lstat> callback.
2132
2133This is similar to the L<Time::HiRes> C<stat> functions, but can return
2134full resolution without rounding and work with standard perl C<stat>,
2135alleviating the need to call the special C<Time::HiRes> functions, which
2136do not act like their perl counterparts.
2137
2138On operating systems or file systems where subsecond time resolution is
2139not supported or could not be detected, a fractional part of C<0> is
2140returned, so it is always safe to call these functions.
2141
2142=over 4
2143
2144=item $seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime, IO::AIO::st_btime
2145
2146Return the access, modication, change or birth time, respectively,
2147including fractional part. Due to the limited precision of floating point,
2148the accuracy on most platforms is only a bit better than milliseconds
2149for times around now - see the I<nsec> function family, below, for full
2150accuracy.
2151
2152File birth time is only available when the OS and perl support it (on
2153FreeBSD and NetBSD at the time of this writing, although support is
2154adaptive, so if your OS/perl gains support, IO::AIO can take advantage of
2155it). On systems where it isn't available, C<0> is currently returned, but
2156this might change to C<undef> in a future version.
2157
2158=item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime
2159
2160Returns access, modification, change and birth time all in one go, and
2161maybe more times in the future version.
2162
2163=item $nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, IO::AIO::st_ctimensec, IO::AIO::st_btimensec
2164
2165Return the fractional access, modifcation, change or birth time, in nanoseconds,
2166as an integer in the range C<0> to C<999999999>.
2167
2168Note that no accessors are provided for access, modification and
2169change times - you need to get those from C<stat _> if required (C<int
2170IO::AIO::st_atime> and so on will I<not> generally give you the correct
2171value).
2172
2173=item $seconds = IO::AIO::st_btimesec
2174
2175The (integral) seconds part of the file birth time, if available.
2176
2177=item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtimensec
2178
2179Like the functions above, but returns all four times in one go (and maybe
2180more in future versions).
2181
2182=item $counter = IO::AIO::st_gen
2183
2184Returns the generation counter (in practice this is just a random number)
2185of the file. This is only available on platforms which have this member in
2186their C<struct stat> (most BSDs at the time of this writing) and generally
2187only to the root usert. If unsupported, C<0> is returned, but this might
2188change to C<undef> in a future version.
2189
2190=back
2191
2192Example: print the high resolution modification time of F</etc>, using
2193C<stat>, and C<IO::AIO::aio_stat>.
2194
2195 if (stat "/etc") {
2196 printf "stat(/etc) mtime: %f\n", IO::AIO::st_mtime;
2197 }
2198
2199 IO::AIO::aio_stat "/etc", sub {
2200 $_[0]
2201 and return;
2202
2203 printf "aio_stat(/etc) mtime: %d.%09d\n", (stat _)[9], IO::AIO::st_mtimensec;
2204 };
2205
2206 IO::AIO::flush;
2207
2208Output of the awbove on my system, showing reduced and full accuracy:
2209
2210 stat(/etc) mtime: 1534043702.020808
2211 aio_stat(/etc) mtime: 1534043702.020807792
2212
2032 2213
2033=head3 MISCELLANEOUS FUNCTIONS 2214=head3 MISCELLANEOUS FUNCTIONS
2034 2215
2035IO::AIO implements some functions that are useful when you want to use 2216IO::AIO implements some functions that are useful when you want to use
2036some "Advanced I/O" function not available to in Perl, without going the 2217some "Advanced I/O" function not available to in Perl, without going the
2037"Asynchronous I/O" route. Many of these have an asynchronous C<aio_*> 2218"Asynchronous I/O" route. Many of these have an asynchronous C<aio_*>
2038counterpart. 2219counterpart.
2039 2220
2040=over 4 2221=over 4
2222
2223=item $numfd = IO::AIO::get_fdlimit
2224
2225Tries to find the current file descriptor limit and returns it, or
2226C<undef> and sets C<$!> in case of an error. The limit is one larger than
2227the highest valid file descriptor number.
2228
2229=item IO::AIO::min_fdlimit [$numfd]
2230
2231Try to increase the current file descriptor limit(s) to at least C<$numfd>
2232by changing the soft or hard file descriptor resource limit. If C<$numfd>
2233is missing, it will try to set a very high limit, although this is not
2234recommended when you know the actual minimum that you require.
2235
2236If the limit cannot be raised enough, the function makes a best-effort
2237attempt to increase the limit as much as possible, using various
2238tricks, while still failing. You can query the resulting limit using
2239C<IO::AIO::get_fdlimit>.
2240
2241If an error occurs, returns C<undef> and sets C<$!>, otherwise returns
2242true.
2041 2243
2042=item IO::AIO::sendfile $ofh, $ifh, $offset, $count 2244=item IO::AIO::sendfile $ofh, $ifh, $offset, $count
2043 2245
2044Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>, 2246Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>,
2045but is blocking (this makes most sense if you know the input data is 2247but is blocking (this makes most sense if you know the input data is
2062=item IO::AIO::madvise $scalar, $offset, $len, $advice 2264=item IO::AIO::madvise $scalar, $offset, $len, $advice
2063 2265
2064Simply calls the C<posix_madvise> function (see its 2266Simply calls the C<posix_madvise> function (see its
2065manpage for details). The following advice constants are 2267manpage for details). The following advice constants are
2066available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, 2268available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
2067C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>, 2269C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>,
2068C<IO::AIO::MADV_FREE>. 2270C<IO::AIO::MADV_DONTNEED>.
2271
2272If C<$offset> is negative, counts from the end. If C<$length> is negative,
2273the remaining length of the C<$scalar> is used. If possible, C<$length>
2274will be reduced to fit into the C<$scalar>.
2069 2275
2070On systems that do not implement C<posix_madvise>, this function returns 2276On systems that do not implement C<posix_madvise>, this function returns
2071ENOSYS, otherwise the return value of C<posix_madvise>. 2277ENOSYS, otherwise the return value of C<posix_madvise>.
2072 2278
2073=item IO::AIO::mprotect $scalar, $offset, $len, $protect 2279=item IO::AIO::mprotect $scalar, $offset, $len, $protect
2075Simply calls the C<mprotect> function on the preferably AIO::mmap'ed 2281Simply calls the C<mprotect> function on the preferably AIO::mmap'ed
2076$scalar (see its manpage for details). The following protect 2282$scalar (see its manpage for details). The following protect
2077constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>, 2283constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,
2078C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>. 2284C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.
2079 2285
2286If C<$offset> is negative, counts from the end. If C<$length> is negative,
2287the remaining length of the C<$scalar> is used. If possible, C<$length>
2288will be reduced to fit into the C<$scalar>.
2289
2080On systems that do not implement C<mprotect>, this function returns 2290On systems that do not implement C<mprotect>, this function returns
2081ENOSYS, otherwise the return value of C<mprotect>. 2291ENOSYS, otherwise the return value of C<mprotect>.
2082 2292
2083=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] 2293=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
2084 2294
2085Memory-maps a file (or anonymous memory range) and attaches it to the 2295Memory-maps a file (or anonymous memory range) and attaches it to the
2086given C<$scalar>, which will act like a string scalar. Returns true on 2296given C<$scalar>, which will act like a string scalar. Returns true on
2087success, and false otherwise. 2297success, and false otherwise.
2088 2298
2299The scalar must exist, but its contents do not matter - this means you
2300cannot use a nonexistant array or hash element. When in doubt, C<undef>
2301the scalar first.
2302
2089The only operations allowed on the scalar are C<substr>/C<vec> that don't 2303The only operations allowed on the mmapped scalar are C<substr>/C<vec>,
2090change the string length, and most read-only operations such as copying it 2304which don't change the string length, and most read-only operations such
2091or searching it with regexes and so on. 2305as copying it or searching it with regexes and so on.
2092 2306
2093Anything else is unsafe and will, at best, result in memory leaks. 2307Anything else is unsafe and will, at best, result in memory leaks.
2094 2308
2095The memory map associated with the C<$scalar> is automatically removed 2309The memory map associated with the C<$scalar> is automatically removed
2096when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or 2310when the C<$scalar> is undef'd or destroyed, or when the C<IO::AIO::mmap>
2097C<IO::AIO::munmap> functions are called. 2311or C<IO::AIO::munmap> functions are called on it.
2098 2312
2099This calls the C<mmap>(2) function internally. See your system's manual 2313This calls the C<mmap>(2) function internally. See your system's manual
2100page for details on the C<$length>, C<$prot> and C<$flags> parameters. 2314page for details on the C<$length>, C<$prot> and C<$flags> parameters.
2101 2315
2102The C<$length> must be larger than zero and smaller than the actual 2316The C<$length> must be larger than zero and smaller than the actual
2115C<IO::AIO::MAP_POPULATE>, 2329C<IO::AIO::MAP_POPULATE>,
2116C<IO::AIO::MAP_NONBLOCK>, 2330C<IO::AIO::MAP_NONBLOCK>,
2117C<IO::AIO::MAP_FIXED>, 2331C<IO::AIO::MAP_FIXED>,
2118C<IO::AIO::MAP_GROWSDOWN>, 2332C<IO::AIO::MAP_GROWSDOWN>,
2119C<IO::AIO::MAP_32BIT>, 2333C<IO::AIO::MAP_32BIT>,
2120C<IO::AIO::MAP_HUGETLB> or 2334C<IO::AIO::MAP_HUGETLB>,
2121C<IO::AIO::MAP_STACK>. 2335C<IO::AIO::MAP_STACK>,
2336C<IO::AIO::MAP_FIXED_NOREPLACE>,
2337C<IO::AIO::MAP_SHARED_VALIDATE>,
2338C<IO::AIO::MAP_SYNC> or
2339C<IO::AIO::MAP_UNINITIALIZED>.
2122 2340
2123If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed. 2341If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
2124 2342
2125C<$offset> is the offset from the start of the file - it generally must be 2343C<$offset> is the offset from the start of the file - it generally must be
2126a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>. 2344a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.
2140 2358
2141=item IO::AIO::munmap $scalar 2359=item IO::AIO::munmap $scalar
2142 2360
2143Removes a previous mmap and undefines the C<$scalar>. 2361Removes a previous mmap and undefines the C<$scalar>.
2144 2362
2363=item IO::AIO::mremap $scalar, $new_length, $flags = MREMAP_MAYMOVE[, $new_address = 0]
2364
2365Calls the Linux-specific mremap(2) system call. The C<$scalar> must have
2366been mapped by C<IO::AIO::mmap>, and C<$flags> must currently either be
2367C<0> or C<IO::AIO::MREMAP_MAYMOVE>.
2368
2369Returns true if successful, and false otherwise. If the underlying mmapped
2370region has changed address, then the true value has the numerical value
2371C<1>, otherwise it has the numerical value C<0>:
2372
2373 my $success = IO::AIO::mremap $mmapped, 8192, IO::AIO::MREMAP_MAYMOVE
2374 or die "mremap: $!";
2375
2376 if ($success*1) {
2377 warn "scalar has chanegd address in memory\n";
2378 }
2379
2380C<IO::AIO::MREMAP_FIXED> and the C<$new_address> argument are currently
2381implemented, but not supported and might go away in a future version.
2382
2383On systems where this call is not supported or is not emulated, this call
2384returns falls and sets C<$!> to C<ENOSYS>.
2385
2386=item IO::AIO::mlockall $flags
2387
2388Calls the C<eio_mlockall_sync> function, which is like C<aio_mlockall>,
2389but is blocking.
2390
2145=item IO::AIO::munlock $scalar, $offset = 0, $length = undef 2391=item IO::AIO::munlock $scalar, $offset = 0, $length = undef
2146 2392
2147Calls the C<munlock> function, undoing the effects of a previous 2393Calls the C<munlock> function, undoing the effects of a previous
2148C<aio_mlock> call (see its description for details). 2394C<aio_mlock> call (see its description for details).
2149 2395
2151 2397
2152Calls the C<munlockall> function. 2398Calls the C<munlockall> function.
2153 2399
2154On systems that do not implement C<munlockall>, this function returns 2400On systems that do not implement C<munlockall>, this function returns
2155ENOSYS, otherwise the return value of C<munlockall>. 2401ENOSYS, otherwise the return value of C<munlockall>.
2402
2403=item $fh = IO::AIO::accept4 $r_fh, $sockaddr, $sockaddr_maxlen, $flags
2404
2405Uses the GNU/Linux C<accept4(2)> syscall, if available, to accept a socket
2406and return the new file handle on success, or sets C<$!> and returns
2407C<undef> on error.
2408
2409The remote name of the new socket will be stored in C<$sockaddr>, which
2410will be extended to allow for at least C<$sockaddr_maxlen> octets. If the
2411socket name does not fit into C<$sockaddr_maxlen> octets, this is signaled
2412by returning a longer string in C<$sockaddr>, which might or might not be
2413truncated.
2414
2415To accept name-less sockets, use C<undef> for C<$sockaddr> and C<0> for
2416C<$sockaddr_maxlen>.
2417
2418The main reasons to use this syscall rather than portable C<accept(2)>
2419are that you can specify C<SOCK_NONBLOCK> and/or C<SOCK_CLOEXEC>
2420flags and you can accept name-less sockets by specifying C<0> for
2421C<$sockaddr_maxlen>, which is sadly not possible with perl's interface to
2422C<accept>.
2156 2423
2157=item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags 2424=item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
2158 2425
2159Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or 2426Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or
2160C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they 2427C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they
2198C<$flags> is non-zero, fails with C<ENOSYS>. 2465C<$flags> is non-zero, fails with C<ENOSYS>.
2199 2466
2200Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the 2467Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the
2201time of this writing, C<IO::AIO::O_CLOEXEC>, C<IO::AIO::O_NONBLOCK> and 2468time of this writing, C<IO::AIO::O_CLOEXEC>, C<IO::AIO::O_NONBLOCK> and
2202C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported. 2469C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported.
2470
2471Example: create a pipe race-free w.r.t. threads and fork:
2472
2473 my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC
2474 or die "pipe2: $!\n";
2475
2476=item $fh = IO::AIO::memfd_create $pathname[, $flags]
2477
2478This is a direct interface to the Linux L<memfd_create(2)> system
2479call. The (unhelpful) default for C<$flags> is C<0>, but your default
2480should be C<IO::AIO::MFD_CLOEXEC>.
2481
2482On success, the new memfd filehandle is returned, otherwise returns
2483C<undef>. If the memfd_create syscall is missing, fails with C<ENOSYS>.
2484
2485Please refer to L<memfd_create(2)> for more info on this call.
2486
2487The following C<$flags> values are available: C<IO::AIO::MFD_CLOEXEC>,
2488C<IO::AIO::MFD_ALLOW_SEALING> and C<IO::AIO::MFD_HUGETLB>.
2489
2490Example: create a new memfd.
2491
2492 my $fh = IO::AIO::memfd_create "somenameforprocfd", IO::AIO::MFD_CLOEXEC
2493 or die "memfd_create: $!\n";
2494
2495=item $fh = IO::AIO::pidfd_open $pid[, $flags]
2496
2497This is an interface to the Linux L<pidfd_open(2)> system call. The
2498default for C<$flags> is C<0>.
2499
2500On success, a new pidfd filehandle is returned (that is already set to
2501close-on-exec), otherwise returns C<undef>. If the syscall is missing,
2502fails with C<ENOSYS>.
2503
2504Example: open pid 6341 as pidfd.
2505
2506 my $fh = IO::AIO::pidfd_open 6341
2507 or die "pidfd_open: $!\n";
2508
2509=item $status = IO::AIO::pidfd_send_signal $pidfh, $signal[, $siginfo[, $flags]]
2510
2511This is an interface to the Linux L<pidfd_send_signal> system call. The
2512default for C<$siginfo> is C<undef> and the default for C<$flags> is C<0>.
2513
2514Returns the system call status. If the syscall is missing, fails with
2515C<ENOSYS>.
2516
2517When specified, C<$siginfo> must be a reference to a hash with one or more
2518of the following members:
2519
2520=over
2521
2522=item code - the C<si_code> member
2523
2524=item pid - the C<si_pid> member
2525
2526=item uid - the C<si_uid> member
2527
2528=item value_int - the C<si_value.sival_int> member
2529
2530=item value_ptr - the C<si_value.sival_ptr> member, specified as an integer
2531
2532=back
2533
2534Example: send a SIGKILL to the specified process.
2535
2536 my $status = IO::AIO::pidfd_send_signal $pidfh, 9, undef
2537 and die "pidfd_send_signal: $!\n";
2538
2539Example: send a SIGKILL to the specified process with extra data.
2540
2541 my $status = IO::AIO::pidfd_send_signal $pidfh, 9, { code => -1, value_int => 7 }
2542 and die "pidfd_send_signal: $!\n";
2543
2544=item $fh = IO::AIO::pidfd_getfd $pidfh, $targetfd[, $flags]
2545
2546This is an interface to the Linux L<pidfd_getfd> system call. The default
2547for C<$flags> is C<0>.
2548
2549On success, returns a dup'ed copy of the target file descriptor (specified
2550as an integer) returned (that is already set to close-on-exec), otherwise
2551returns C<undef>. If the syscall is missing, fails with C<ENOSYS>.
2552
2553Example: get a copy of standard error of another process and print soemthing to it.
2554
2555 my $errfh = IO::AIO::pidfd_getfd $pidfh, 2
2556 or die "pidfd_getfd: $!\n";
2557 print $errfh "stderr\n";
2558
2559=item $fh = IO::AIO::eventfd [$initval, [$flags]]
2560
2561This is a direct interface to the Linux L<eventfd(2)> system call. The
2562(unhelpful) defaults for C<$initval> and C<$flags> are C<0> for both.
2563
2564On success, the new eventfd filehandle is returned, otherwise returns
2565C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>.
2566
2567Please refer to L<eventfd(2)> for more info on this call.
2568
2569The following symbol flag values are available: C<IO::AIO::EFD_CLOEXEC>,
2570C<IO::AIO::EFD_NONBLOCK> and C<IO::AIO::EFD_SEMAPHORE> (Linux 2.6.30).
2571
2572Example: create a new eventfd filehandle:
2573
2574 $fh = IO::AIO::eventfd 0, IO::AIO::EFD_CLOEXEC
2575 or die "eventfd: $!\n";
2576
2577=item $fh = IO::AIO::timerfd_create $clockid[, $flags]
2578
2579This is a direct interface to the Linux L<timerfd_create(2)> system
2580call. The (unhelpful) default for C<$flags> is C<0>, but your default
2581should be C<IO::AIO::TFD_CLOEXEC>.
2582
2583On success, the new timerfd filehandle is returned, otherwise returns
2584C<undef>. If the timerfd_create syscall is missing, fails with C<ENOSYS>.
2585
2586Please refer to L<timerfd_create(2)> for more info on this call.
2587
2588The following C<$clockid> values are
2589available: C<IO::AIO::CLOCK_REALTIME>, C<IO::AIO::CLOCK_MONOTONIC>
2590C<IO::AIO::CLOCK_CLOCK_BOOTTIME> (Linux 3.15)
2591C<IO::AIO::CLOCK_CLOCK_REALTIME_ALARM> (Linux 3.11) and
2592C<IO::AIO::CLOCK_CLOCK_BOOTTIME_ALARM> (Linux 3.11).
2593
2594The following C<$flags> values are available (Linux
25952.6.27): C<IO::AIO::TFD_NONBLOCK> and C<IO::AIO::TFD_CLOEXEC>.
2596
2597Example: create a new timerfd and set it to one-second repeated alarms,
2598then wait for two alarms:
2599
2600 my $fh = IO::AIO::timerfd_create IO::AIO::CLOCK_BOOTTIME, IO::AIO::TFD_CLOEXEC
2601 or die "timerfd_create: $!\n";
2602
2603 defined IO::AIO::timerfd_settime $fh, 0, 1, 1
2604 or die "timerfd_settime: $!\n";
2605
2606 for (1..2) {
2607 8 == sysread $fh, my $buf, 8
2608 or die "timerfd read failure\n";
2609
2610 printf "number of expirations (likely 1): %d\n",
2611 unpack "Q", $buf;
2612 }
2613
2614=item ($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags, $new_interval, $nbw_value
2615
2616This is a direct interface to the Linux L<timerfd_settime(2)> system
2617call. Please refer to its manpage for more info on this call.
2618
2619The new itimerspec is specified using two (possibly fractional) second
2620values, C<$new_interval> and C<$new_value>).
2621
2622On success, the current interval and value are returned (as per
2623C<timerfd_gettime>). On failure, the empty list is returned.
2624
2625The following C<$flags> values are
2626available: C<IO::AIO::TFD_TIMER_ABSTIME> and
2627C<IO::AIO::TFD_TIMER_CANCEL_ON_SET>.
2628
2629See C<IO::AIO::timerfd_create> for a full example.
2630
2631=item ($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh
2632
2633This is a direct interface to the Linux L<timerfd_gettime(2)> system
2634call. Please refer to its manpage for more info on this call.
2635
2636On success, returns the current values of interval and value for the given
2637timerfd (as potentially fractional second values). On failure, the empty
2638list is returned.
2203 2639
2204=back 2640=back
2205 2641
2206=cut 2642=cut
2207 2643
2273the process will result in undefined behaviour. Calling it at any time 2709the process will result in undefined behaviour. Calling it at any time
2274will also result in any undefined (by POSIX) behaviour. 2710will also result in any undefined (by POSIX) behaviour.
2275 2711
2276=back 2712=back
2277 2713
2714=head2 LINUX-SPECIFIC CALLS
2715
2716When a call is documented as "linux-specific" then this means it
2717originated on GNU/Linux. C<IO::AIO> will usually try to autodetect the
2718availability and compatibility of such calls regardless of the platform
2719it is compiled on, so platforms such as FreeBSD which often implement
2720these calls will work. When in doubt, call them and see if they fail wth
2721C<ENOSYS>.
2722
2278=head2 MEMORY USAGE 2723=head2 MEMORY USAGE
2279 2724
2280Per-request usage: 2725Per-request usage:
2281 2726
2282Each aio request uses - depending on your architecture - around 100-200 2727Each aio request uses - depending on your architecture - around 100-200
2294temporary buffers, and each thread requires a stack and other data 2739temporary buffers, and each thread requires a stack and other data
2295structures (usually around 16k-128k, depending on the OS). 2740structures (usually around 16k-128k, depending on the OS).
2296 2741
2297=head1 KNOWN BUGS 2742=head1 KNOWN BUGS
2298 2743
2299Known bugs will be fixed in the next release. 2744Known bugs will be fixed in the next release :)
2745
2746=head1 KNOWN ISSUES
2747
2748Calls that try to "import" foreign memory areas (such as C<IO::AIO::mmap>
2749or C<IO::AIO::aio_slurp>) do not work with generic lvalues, such as
2750non-created hash slots or other scalars I didn't think of. It's best to
2751avoid such and either use scalar variables or making sure that the scalar
2752exists (e.g. by storing C<undef>) and isn't "funny" (e.g. tied).
2753
2754I am not sure anything can be done about this, so this is considered a
2755known issue, rather than a bug.
2300 2756
2301=head1 SEE ALSO 2757=head1 SEE ALSO
2302 2758
2303L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a 2759L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
2304more natural syntax. 2760more natural syntax and L<IO::FDPass> for file descriptor passing.
2305 2761
2306=head1 AUTHOR 2762=head1 AUTHOR
2307 2763
2308 Marc Lehmann <schmorp@schmorp.de> 2764 Marc Lehmann <schmorp@schmorp.de>
2309 http://home.schmorp.de/ 2765 http://home.schmorp.de/

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines