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.226 by root, Mon May 28 17:00:19 2012 UTC vs.
Revision 1.267 by root, Tue Aug 9 11:39:17 2016 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
68=head2 EXAMPLE 72=head2 EXAMPLE
69 73
70This is a simple example that uses the EV module and loads 74This is a simple example that uses the EV module and loads
71F</etc/passwd> asynchronously: 75F</etc/passwd> asynchronously:
72 76
73 use Fcntl;
74 use EV; 77 use EV;
75 use IO::AIO; 78 use IO::AIO;
76 79
77 # register the IO::AIO callback with EV 80 # register the IO::AIO callback with EV
78 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; 81 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
95 98
96 # file contents now in $contents 99 # file contents now in $contents
97 print $contents; 100 print $contents;
98 101
99 # exit event loop and program 102 # exit event loop and program
100 EV::unloop; 103 EV::break;
101 }; 104 };
102 }; 105 };
103 106
104 # possibly queue up other requests, or open GUI windows, 107 # possibly queue up other requests, or open GUI windows,
105 # check for sockets etc. etc. 108 # check for sockets etc. etc.
106 109
107 # process events as long as there are some: 110 # process events as long as there are some:
108 EV::loop; 111 EV::run;
109 112
110=head1 REQUEST ANATOMY AND LIFETIME 113=head1 REQUEST ANATOMY AND LIFETIME
111 114
112Every C<aio_*> function creates a request. which is a C data structure not 115Every C<aio_*> function creates a request. which is a C data structure not
113directly visible to Perl. 116directly visible to Perl.
168use common::sense; 171use common::sense;
169 172
170use base 'Exporter'; 173use base 'Exporter';
171 174
172BEGIN { 175BEGIN {
173 our $VERSION = '4.15'; 176 our $VERSION = 4.34;
174 177
175 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
176 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
177 aio_scandir aio_symlink aio_readlink aio_realpath aio_sync 180 aio_scandir aio_symlink aio_readlink aio_realpath aio_fcntl aio_ioctl
178 aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_fallocate 181 aio_sync aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range
179 aio_pathsync aio_readahead aio_fiemap 182 aio_pathsync aio_readahead aio_fiemap aio_allocate
180 aio_rename aio_link aio_move aio_copy aio_group 183 aio_rename aio_link aio_move aio_copy aio_group
181 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
182 aio_chmod aio_utime aio_truncate 185 aio_chmod aio_utime aio_truncate
183 aio_msync aio_mtouch aio_mlock aio_mlockall 186 aio_msync aio_mtouch aio_mlock aio_mlockall
184 aio_statvfs 187 aio_statvfs
202 205
203=head1 FUNCTIONS 206=head1 FUNCTIONS
204 207
205=head2 QUICK OVERVIEW 208=head2 QUICK OVERVIEW
206 209
207This section simply lists the prototypes of the most important functions 210This section simply lists the prototypes most of the functions for
208for quick reference. See the following sections for function-by-function 211quick reference. See the following sections for function-by-function
209documentation. 212documentation.
210 213
211 aio_wd $pathname, $callback->($wd) 214 aio_wd $pathname, $callback->($wd)
212 aio_open $pathname, $flags, $mode, $callback->($fh) 215 aio_open $pathname, $flags, $mode, $callback->($fh)
213 aio_close $fh, $callback->($status) 216 aio_close $fh, $callback->($status)
221 aio_statvfs $fh_or_path, $callback->($statvfs) 224 aio_statvfs $fh_or_path, $callback->($statvfs)
222 aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 225 aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
223 aio_chown $fh_or_path, $uid, $gid, $callback->($status) 226 aio_chown $fh_or_path, $uid, $gid, $callback->($status)
224 aio_chmod $fh_or_path, $mode, $callback->($status) 227 aio_chmod $fh_or_path, $mode, $callback->($status)
225 aio_truncate $fh_or_path, $offset, $callback->($status) 228 aio_truncate $fh_or_path, $offset, $callback->($status)
229 aio_allocate $fh, $mode, $offset, $len, $callback->($status)
230 aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
226 aio_unlink $pathname, $callback->($status) 231 aio_unlink $pathname, $callback->($status)
227 aio_mknod $pathname, $mode, $dev, $callback->($status) 232 aio_mknod $pathname, $mode, $dev, $callback->($status)
228 aio_link $srcpath, $dstpath, $callback->($status) 233 aio_link $srcpath, $dstpath, $callback->($status)
229 aio_symlink $srcpath, $dstpath, $callback->($status) 234 aio_symlink $srcpath, $dstpath, $callback->($status)
230 aio_readlink $pathname, $callback->($link) 235 aio_readlink $pathname, $callback->($link)
231 aio_realpath $pathname, $callback->($link) 236 aio_realpath $pathname, $callback->($path)
232 aio_rename $srcpath, $dstpath, $callback->($status) 237 aio_rename $srcpath, $dstpath, $callback->($status)
233 aio_mkdir $pathname, $mode, $callback->($status) 238 aio_mkdir $pathname, $mode, $callback->($status)
234 aio_rmdir $pathname, $callback->($status) 239 aio_rmdir $pathname, $callback->($status)
235 aio_readdir $pathname, $callback->($entries) 240 aio_readdir $pathname, $callback->($entries)
236 aio_readdirx $pathname, $flags, $callback->($entries, $flags) 241 aio_readdirx $pathname, $flags, $callback->($entries, $flags)
239 aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs) 244 aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
240 aio_load $pathname, $data, $callback->($status) 245 aio_load $pathname, $data, $callback->($status)
241 aio_copy $srcpath, $dstpath, $callback->($status) 246 aio_copy $srcpath, $dstpath, $callback->($status)
242 aio_move $srcpath, $dstpath, $callback->($status) 247 aio_move $srcpath, $dstpath, $callback->($status)
243 aio_rmtree $pathname, $callback->($status) 248 aio_rmtree $pathname, $callback->($status)
249 aio_fcntl $fh, $cmd, $arg, $callback->($status)
250 aio_ioctl $fh, $request, $buf, $callback->($status)
244 aio_sync $callback->($status) 251 aio_sync $callback->($status)
245 aio_syncfs $fh, $callback->($status) 252 aio_syncfs $fh, $callback->($status)
246 aio_fsync $fh, $callback->($status) 253 aio_fsync $fh, $callback->($status)
247 aio_fdatasync $fh, $callback->($status) 254 aio_fdatasync $fh, $callback->($status)
248 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) 255 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
360 367
361 368
362=item aio_open $pathname, $flags, $mode, $callback->($fh) 369=item aio_open $pathname, $flags, $mode, $callback->($fh)
363 370
364Asynchronously open or create a file and call the callback with a newly 371Asynchronously open or create a file and call the callback with a newly
365created filehandle for the file. 372created filehandle for the file (or C<undef> in case of an error).
366 373
367The pathname passed to C<aio_open> must be absolute. See API NOTES, above, 374The pathname passed to C<aio_open> must be absolute. See API NOTES, above,
368for an explanation. 375for an explanation.
369 376
370The C<$flags> argument is a bitmask. See the C<Fcntl> module for a 377The C<$flags> argument is a bitmask. See the C<Fcntl> module for a
393following POSIX and non-POSIX constants are available (missing ones on 400following POSIX and non-POSIX constants are available (missing ones on
394your system are, as usual, C<0>): 401your system are, as usual, C<0>):
395 402
396C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>, 403C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>,
397C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>, 404C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>,
398C<O_RSYNC>, C<O_SYNC> and C<O_TTY_INIT>. 405C<O_RSYNC>, C<O_SYNC>, C<O_PATH>, C<O_TMPFILE>, and C<O_TTY_INIT>.
399 406
400 407
401=item aio_close $fh, $callback->($status) 408=item aio_close $fh, $callback->($status)
402 409
403Asynchronously close a file and call the callback with the result 410Asynchronously close a file and call the callback with the result
438=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 445=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
439 446
440=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 447=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
441 448
442Reads or writes C<$length> bytes from or to the specified C<$fh> and 449Reads or writes C<$length> bytes from or to the specified C<$fh> and
443C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> 450C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> and
444and calls the callback without the actual number of bytes read (or -1 on 451calls the callback with the actual number of bytes transferred (or -1 on
445error, just like the syscall). 452error, just like the syscall).
446 453
447C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to 454C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to
448offset plus the actual number of bytes read. 455offset plus the actual number of bytes read.
449 456
507As native sendfile syscalls (as practically any non-POSIX interface hacked 514As native sendfile syscalls (as practically any non-POSIX interface hacked
508together in a hurry to improve benchmark numbers) tend to be rather buggy 515together in a hurry to improve benchmark numbers) tend to be rather buggy
509on many systems, this implementation tries to work around some known bugs 516on many systems, this implementation tries to work around some known bugs
510in Linux and FreeBSD kernels (probably others, too), but that might fail, 517in Linux and FreeBSD kernels (probably others, too), but that might fail,
511so you really really should check the return value of C<aio_sendfile> - 518so you really really should check the return value of C<aio_sendfile> -
512fewre bytes than expected might have been transferred. 519fewer bytes than expected might have been transferred.
513 520
514 521
515=item aio_readahead $fh,$offset,$length, $callback->($retval) 522=item aio_readahead $fh,$offset,$length, $callback->($retval)
516 523
517C<aio_readahead> populates the page cache with data from a file so that 524C<aio_readahead> populates the page cache with data from a file so that
521whole pages, so that offset is effectively rounded down to a page boundary 528whole pages, so that offset is effectively rounded down to a page boundary
522and bytes are read up to the next page boundary greater than or equal to 529and bytes are read up to the next page boundary greater than or equal to
523(off-set+length). C<aio_readahead> does not read beyond the end of the 530(off-set+length). C<aio_readahead> does not read beyond the end of the
524file. The current file offset of the file is left unchanged. 531file. The current file offset of the file is left unchanged.
525 532
526If that syscall doesn't exist (likely if your OS isn't Linux) it will be 533If that syscall doesn't exist (likely if your kernel isn't Linux) it will
527emulated by simply reading the data, which would have a similar effect. 534be emulated by simply reading the data, which would have a similar effect.
528 535
529 536
530=item aio_stat $fh_or_path, $callback->($status) 537=item aio_stat $fh_or_path, $callback->($status)
531 538
532=item aio_lstat $fh, $callback->($status) 539=item aio_lstat $fh, $callback->($status)
601 namemax => 255, 608 namemax => 255,
602 frsize => 1024, 609 frsize => 1024,
603 fsid => 1810 610 fsid => 1810
604 } 611 }
605 612
613Here is a (likely partial - send me updates!) list of fsid values used by
614Linux - it is safe to hardcode these when C<$^O> is C<linux>:
615
616 0x0000adf5 adfs
617 0x0000adff affs
618 0x5346414f afs
619 0x09041934 anon-inode filesystem
620 0x00000187 autofs
621 0x42465331 befs
622 0x1badface bfs
623 0x42494e4d binfmt_misc
624 0x9123683e btrfs
625 0x0027e0eb cgroupfs
626 0xff534d42 cifs
627 0x73757245 coda
628 0x012ff7b7 coh
629 0x28cd3d45 cramfs
630 0x453dcd28 cramfs-wend (wrong endianness)
631 0x64626720 debugfs
632 0x00001373 devfs
633 0x00001cd1 devpts
634 0x0000f15f ecryptfs
635 0x00414a53 efs
636 0x0000137d ext
637 0x0000ef53 ext2/ext3/ext4
638 0x0000ef51 ext2
639 0xf2f52010 f2fs
640 0x00004006 fat
641 0x65735546 fuseblk
642 0x65735543 fusectl
643 0x0bad1dea futexfs
644 0x01161970 gfs2
645 0x47504653 gpfs
646 0x00004244 hfs
647 0xf995e849 hpfs
648 0x00c0ffee hostfs
649 0x958458f6 hugetlbfs
650 0x2bad1dea inotifyfs
651 0x00009660 isofs
652 0x000072b6 jffs2
653 0x3153464a jfs
654 0x6b414653 k-afs
655 0x0bd00bd0 lustre
656 0x0000137f minix
657 0x0000138f minix 30 char names
658 0x00002468 minix v2
659 0x00002478 minix v2 30 char names
660 0x00004d5a minix v3
661 0x19800202 mqueue
662 0x00004d44 msdos
663 0x0000564c novell
664 0x00006969 nfs
665 0x6e667364 nfsd
666 0x00003434 nilfs
667 0x5346544e ntfs
668 0x00009fa1 openprom
669 0x7461636F ocfs2
670 0x00009fa0 proc
671 0x6165676c pstorefs
672 0x0000002f qnx4
673 0x68191122 qnx6
674 0x858458f6 ramfs
675 0x52654973 reiserfs
676 0x00007275 romfs
677 0x67596969 rpc_pipefs
678 0x73636673 securityfs
679 0xf97cff8c selinux
680 0x0000517b smb
681 0x534f434b sockfs
682 0x73717368 squashfs
683 0x62656572 sysfs
684 0x012ff7b6 sysv2
685 0x012ff7b5 sysv4
686 0x01021994 tmpfs
687 0x15013346 udf
688 0x00011954 ufs
689 0x54190100 ufs byteswapped
690 0x00009fa2 usbdevfs
691 0x01021997 v9fs
692 0xa501fcf5 vxfs
693 0xabba1974 xenfs
694 0x012ff7b4 xenix
695 0x58465342 xfs
696 0x012fd16d xia
606 697
607=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 698=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
608 699
609Works like perl's C<utime> function (including the special case of $atime 700Works like perl's C<utime> function (including the special case of $atime
610and $mtime being undef). Fractional times are supported if the underlying 701and $mtime being undef). Fractional times are supported if the underlying
638=item aio_truncate $fh_or_path, $offset, $callback->($status) 729=item aio_truncate $fh_or_path, $offset, $callback->($status)
639 730
640Works like truncate(2) or ftruncate(2). 731Works like truncate(2) or ftruncate(2).
641 732
642 733
734=item aio_allocate $fh, $mode, $offset, $len, $callback->($status)
735
736Allocates or frees disk space according to the C<$mode> argument. See the
737linux C<fallocate> documentation for details.
738
739C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate
740space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE | IO::AIO::FALLOC_FL_KEEP_SIZE>,
741to deallocate a file range.
742
743IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range
744(without leaving a hole) and C<FALLOC_FL_ZERO_RANGE>, to zero a range (see
745your L<fallocate(2)> manpage).
746
747The file system block size used by C<fallocate> is presumably the
748C<f_bsize> returned by C<statvfs>.
749
750If C<fallocate> isn't available or cannot be emulated (currently no
751emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>.
752
753
643=item aio_chmod $fh_or_path, $mode, $callback->($status) 754=item aio_chmod $fh_or_path, $mode, $callback->($status)
644 755
645Works like perl's C<chmod> function. 756Works like perl's C<chmod> function.
646 757
647 758
684 795
685 796
686=item aio_realpath $pathname, $callback->($path) 797=item aio_realpath $pathname, $callback->($path)
687 798
688Asynchronously make the path absolute and resolve any symlinks in 799Asynchronously make the path absolute and resolve any symlinks in
689C<$path>. The resulting path only consists of directories (Same as 800C<$path>. The resulting path only consists of directories (same as
690L<Cwd::realpath>). 801L<Cwd::realpath>).
691 802
692This request can be used to get the absolute path of the current working 803This request can be used to get the absolute path of the current working
693directory by passing it a path of F<.> (a single dot). 804directory by passing it a path of F<.> (a single dot).
694 805
695 806
696=item aio_rename $srcpath, $dstpath, $callback->($status) 807=item aio_rename $srcpath, $dstpath, $callback->($status)
697 808
698Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as 809Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
699rename(2) and call the callback with the result code. 810rename(2) and call the callback with the result code.
811
812On systems that support the AIO::WD working directory abstraction
813natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead
814of failing, C<rename> is called on the absolute path of C<$wd>.
700 815
701 816
702=item aio_mkdir $pathname, $mode, $callback->($status) 817=item aio_mkdir $pathname, $mode, $callback->($status)
703 818
704Asynchronously mkdir (create) a directory and call the callback with 819Asynchronously mkdir (create) a directory and call the callback with
708 823
709=item aio_rmdir $pathname, $callback->($status) 824=item aio_rmdir $pathname, $callback->($status)
710 825
711Asynchronously rmdir (delete) a directory and call the callback with the 826Asynchronously rmdir (delete) a directory and call the callback with the
712result code. 827result code.
828
829On systems that support the AIO::WD working directory abstraction
830natively, the case C<[$wd, "."]> is specialcased - instead of failing,
831C<rmdir> is called on the absolute path of C<$wd>.
713 832
714 833
715=item aio_readdir $pathname, $callback->($entries) 834=item aio_readdir $pathname, $callback->($entries)
716 835
717Unlike the POSIX call of the same name, C<aio_readdir> reads an entire 836Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
1082} 1201}
1083 1202
1084=item aio_rmtree $pathname, $callback->($status) 1203=item aio_rmtree $pathname, $callback->($status)
1085 1204
1086Delete a directory tree starting (and including) C<$path>, return the 1205Delete a directory tree starting (and including) C<$path>, return the
1087status of the final C<rmdir> only. This is a composite request that 1206status of the final C<rmdir> only. This is a composite request that
1088uses C<aio_scandir> to recurse into and rmdir directories, and unlink 1207uses C<aio_scandir> to recurse into and rmdir directories, and unlink
1089everything else. 1208everything else.
1090 1209
1091=cut 1210=cut
1092 1211
1113 add $grp $dirgrp; 1232 add $grp $dirgrp;
1114 }; 1233 };
1115 1234
1116 $grp 1235 $grp
1117} 1236}
1237
1238=item aio_fcntl $fh, $cmd, $arg, $callback->($status)
1239
1240=item aio_ioctl $fh, $request, $buf, $callback->($status)
1241
1242These work just like the C<fcntl> and C<ioctl> built-in functions, except
1243they execute asynchronously and pass the return value to the callback.
1244
1245Both calls can be used for a lot of things, some of which make more sense
1246to run asynchronously in their own thread, while some others make less
1247sense. For example, calls that block waiting for external events, such
1248as locking, will also lock down an I/O thread while it is waiting, which
1249can deadlock the whole I/O system. At the same time, there might be no
1250alternative to using a thread to wait.
1251
1252So in general, you should only use these calls for things that do
1253(filesystem) I/O, not for things that wait for other events (network,
1254other processes), although if you are careful and know what you are doing,
1255you still can.
1256
1257The following constants are available (missing ones are, as usual C<0>):
1258
1259C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>.
1260
1261C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>,
1262C<FS_IOC_FIEMAP>.
1263
1264C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>,
1265C<FS_IOC_GET_ENCRYPTION_PWSALT>, C<FS_IOC_GET_ENCRYPTION_POLICY>, C<FS_KEY_DESCRIPTOR_SIZE>.
1266
1267C<FS_SECRM_FL>, C<FS_UNRM_FL>, C<FS_COMPR_FL>, C<FS_SYNC_FL>, C<FS_IMMUTABLE_FL>,
1268C<FS_APPEND_FL>, C<FS_NODUMP_FL>, C<FS_NOATIME_FL>, C<FS_DIRTY_FL>,
1269C<FS_COMPRBLK_FL>, C<FS_NOCOMP_FL>, C<FS_ENCRYPT_FL>, C<FS_BTREE_FL>,
1270C<FS_INDEX_FL>, C<FS_JOURNAL_DATA_FL>, C<FS_NOTAIL_FL>, C<FS_DIRSYNC_FL>, C<FS_TOPDIR_FL>,
1271C<FS_FL_USER_MODIFIABLE>.
1272
1273C<FS_XFLAG_REALTIME>, C<FS_XFLAG_PREALLOC>, C<FS_XFLAG_IMMUTABLE>, C<FS_XFLAG_APPEND>,
1274C<FS_XFLAG_SYNC>, C<FS_XFLAG_NOATIME>, C<FS_XFLAG_NODUMP>, C<FS_XFLAG_RTINHERIT>,
1275C<FS_XFLAG_PROJINHERIT>, C<FS_XFLAG_NOSYMLINKS>, C<FS_XFLAG_EXTSIZE>, C<FS_XFLAG_EXTSZINHERIT>,
1276C<FS_XFLAG_NODEFRAG>, C<FS_XFLAG_FILESTREAM>, C<FS_XFLAG_DAX>, C<FS_XFLAG_HASATTR>,
1118 1277
1119=item aio_sync $callback->($status) 1278=item aio_sync $callback->($status)
1120 1279
1121Asynchronously call sync and call the callback when finished. 1280Asynchronously call sync and call the callback when finished.
1122 1281
1212 1371
1213This is a rather advanced IO::AIO call, which works best on mmap(2)ed 1372This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1214scalars. 1373scalars.
1215 1374
1216It touches (reads or writes) all memory pages in the specified 1375It touches (reads or writes) all memory pages in the specified
1217range inside the scalar. All caveats and parameters are the same 1376range inside the scalar. All caveats and parameters are the same
1218as for C<aio_msync>, above, except for flags, which must be either 1377as for C<aio_msync>, above, except for flags, which must be either
1219C<0> (which reads all pages and ensures they are instantiated) or 1378C<0> (which reads all pages and ensures they are instantiated) or
1220C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and 1379C<IO::AIO::MT_MODIFY>, which modifies the memory pages (by reading and
1221writing an octet from it, which dirties the page). 1380writing an octet from it, which dirties the page).
1222 1381
1223=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) 1382=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
1224 1383
1225This is a rather advanced IO::AIO call, which works best on mmap(2)ed 1384This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1259 1418
1260 aio_mlockall IO::AIO::MCL_FUTURE; 1419 aio_mlockall IO::AIO::MCL_FUTURE;
1261 1420
1262=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents) 1421=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
1263 1422
1264Queries the extents of the given file (by calling the Linux FIEMAP ioctl, 1423Queries the extents of the given file (by calling the Linux C<FIEMAP>
1265see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If the 1424ioctl, see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If
1266C<ioctl> is not available on your OS, then this rquiest will fail with 1425the ioctl is not available on your OS, then this request will fail with
1267C<ENOSYS>. 1426C<ENOSYS>.
1268 1427
1269C<$start> is the starting offset to query extents for, C<$length> is the 1428C<$start> is the starting offset to query extents for, C<$length> is the
1270size of the range to query - if it is C<undef>, then the whole file will 1429size of the range to query - if it is C<undef>, then the whole file will
1271be queried. 1430be queried.
1274C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also 1433C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also
1275exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query 1434exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query
1276the data portion. 1435the data portion.
1277 1436
1278C<$count> is the maximum number of extent records to return. If it is 1437C<$count> is the maximum number of extent records to return. If it is
1279C<undef>, then IO::AIO queries all extents of the file. As a very special 1438C<undef>, then IO::AIO queries all extents of the range. As a very special
1280case, if it is C<0>, then the callback receives the number of extents 1439case, if it is C<0>, then the callback receives the number of extents
1281instead of the extents themselves. 1440instead of the extents themselves (which is unreliable, see below).
1282 1441
1283If an error occurs, the callback receives no arguments. The special 1442If an error occurs, the callback receives no arguments. The special
1284C<errno> value C<IO::AIO::EBADR> is available to test for flag errors. 1443C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.
1285 1444
1286Otherwise, the callback receives an array reference with extent 1445Otherwise, the callback receives an array reference with extent
1288following members: 1447following members:
1289 1448
1290 [$logical, $physical, $length, $flags] 1449 [$logical, $physical, $length, $flags]
1291 1450
1292Flags is any combination of the following flag values (typically either C<0> 1451Flags is any combination of the following flag values (typically either C<0>
1293or C<IO::AIO::FIEMAP_EXTENT_LAST>): 1452or C<IO::AIO::FIEMAP_EXTENT_LAST> (1)):
1294 1453
1295C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>, 1454C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,
1296C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>, 1455C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,
1297C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>, 1456C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,
1298C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>, 1457C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,
1299C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or 1458C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or
1300C<IO::AIO::FIEMAP_EXTENT_SHARED>. 1459C<IO::AIO::FIEMAP_EXTENT_SHARED>.
1301 1460
1461At the time of this writing (Linux 3.2), this requets is unreliable unless
1462C<$count> is C<undef>, as the kernel has all sorts of bugs preventing
1463it to return all extents of a range for files with large number of
1464extents. The code works around all these issues if C<$count> is undef.
1465
1302=item aio_group $callback->(...) 1466=item aio_group $callback->(...)
1303 1467
1304This is a very special aio request: Instead of doing something, it is a 1468This is a very special aio request: Instead of doing something, it is a
1305container for other aio requests, which is useful if you want to bundle 1469container for other aio requests, which is useful if you want to bundle
1306many requests into a single, composite, request with a definite callback 1470many requests into a single, composite, request with a definite callback
1389 aio_stat [$etcdir, "passwd"], sub { 1553 aio_stat [$etcdir, "passwd"], sub {
1390 # yay 1554 # yay
1391 }; 1555 };
1392 }; 1556 };
1393 1557
1394That C<aio_wd> is a request and not a normal function shows that creating 1558The fact that C<aio_wd> is a request and not a normal function shows that
1395an IO::AIO::WD object is itself a potentially blocking operation, which is 1559creating an IO::AIO::WD object is itself a potentially blocking operation,
1396why it is done asynchronously. 1560which is why it is done asynchronously.
1397 1561
1398To stat the directory obtained with C<aio_wd> above, one could write 1562To stat the directory obtained with C<aio_wd> above, one could write
1399either of the following three request calls: 1563either of the following three request calls:
1400 1564
1401 aio_lstat "/etc" , sub { ... # pathname as normal string 1565 aio_lstat "/etc" , sub { ... # pathname as normal string
1421will still point to the original directory. Most functions accepting a 1585will still point to the original directory. Most functions accepting a
1422pathname will use the directory fd on newer systems, and the string on 1586pathname will use the directory fd on newer systems, and the string on
1423older systems. Some functions (such as realpath) will always rely on the 1587older systems. Some functions (such as realpath) will always rely on the
1424string form of the pathname. 1588string form of the pathname.
1425 1589
1426So this fucntionality is mainly useful to get some protection against 1590So this functionality is mainly useful to get some protection against
1427C<chdir>, to easily get an absolute path out of a relative path for future 1591C<chdir>, to easily get an absolute path out of a relative path for future
1428reference, and to speed up doing many operations in the same directory 1592reference, and to speed up doing many operations in the same directory
1429(e.g. when stat'ing all files in a directory). 1593(e.g. when stat'ing all files in a directory).
1430 1594
1431The following functions implement this working directory abstraction: 1595The following functions implement this working directory abstraction:
1444passing C<undef> as working directory component of a pathname fails the 1608passing C<undef> as working directory component of a pathname fails the
1445request with C<ENOENT>, there is often no need for error checking in the 1609request with C<ENOENT>, there is often no need for error checking in the
1446C<aio_wd> callback, as future requests using the value will fail in the 1610C<aio_wd> callback, as future requests using the value will fail in the
1447expected way. 1611expected way.
1448 1612
1449If this call isn't available because your OS lacks it or it couldn't be
1450detected, it will be emulated by calling C<fsync> instead.
1451
1452=item IO::AIO::CWD 1613=item IO::AIO::CWD
1453 1614
1454This is a compiletime constant (object) that represents the process 1615This is a compiletime constant (object) that represents the process
1455current working directory. 1616current working directory.
1456 1617
1457Specifying this object as working directory object for a pathname is as 1618Specifying this object as working directory object for a pathname is as if
1458if the pathname would be specified directly, without a directory object, 1619the pathname would be specified directly, without a directory object. For
1459e.g., these calls are functionally identical: 1620example, these calls are functionally identical:
1460 1621
1461 aio_stat "somefile", sub { ... }; 1622 aio_stat "somefile", sub { ... };
1462 aio_stat [IO::AIO::CWD, "somefile"], sub { ... }; 1623 aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
1463 1624
1464=back 1625=back
1465 1626
1627To recover the path associated with an IO::AIO::WD object, you can use
1628C<aio_realpath>:
1629
1630 aio_realpath $wd, sub {
1631 warn "path is $_[0]\n";
1632 };
1633
1634Currently, C<aio_statvfs> always, and C<aio_rename> and C<aio_rmdir>
1635sometimes, fall back to using an absolue path.
1466 1636
1467=head2 IO::AIO::REQ CLASS 1637=head2 IO::AIO::REQ CLASS
1468 1638
1469All non-aggregate C<aio_*> functions return an object of this class when 1639All non-aggregate C<aio_*> functions return an object of this class when
1470called in non-void context. 1640called in non-void context.
1648 1818
1649See C<poll_cb> for an example. 1819See C<poll_cb> for an example.
1650 1820
1651=item IO::AIO::poll_cb 1821=item IO::AIO::poll_cb
1652 1822
1653Process some outstanding events on the result pipe. You have to call 1823Process some requests that have reached the result phase (i.e. they have
1824been executed but the results are not yet reported). You have to call
1825this "regularly" to finish outstanding requests.
1826
1654this regularly. Returns C<0> if all events could be processed (or there 1827Returns C<0> if all events could be processed (or there were no
1655were no events to process), or C<-1> if it returned earlier for whatever 1828events to process), or C<-1> if it returned earlier for whatever
1656reason. Returns immediately when no events are outstanding. The amount of 1829reason. Returns immediately when no events are outstanding. The amount
1657events processed depends on the settings of C<IO::AIO::max_poll_req> and 1830of events processed depends on the settings of C<IO::AIO::max_poll_req>,
1658C<IO::AIO::max_poll_time>. 1831C<IO::AIO::max_poll_time> and C<IO::AIO::max_outstanding>.
1659 1832
1660If not all requests were processed for whatever reason, the filehandle 1833If not all requests were processed for whatever reason, the poll file
1661will still be ready when C<poll_cb> returns, so normally you don't have to 1834descriptor will still be ready when C<poll_cb> returns, so normally you
1662do anything special to have it called later. 1835don't have to do anything special to have it called later.
1663 1836
1664Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes 1837Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes
1665ready, it can be beneficial to call this function from loops which submit 1838ready, it can be beneficial to call this function from loops which submit
1666a lot of requests, to make sure the results get processed when they become 1839a lot of requests, to make sure the results get processed when they become
1667available and not just when the loop is finished and the event loop takes 1840available and not just when the loop is finished and the event loop takes
1676 poll => 'r', async => 1, 1849 poll => 'r', async => 1,
1677 cb => \&IO::AIO::poll_cb); 1850 cb => \&IO::AIO::poll_cb);
1678 1851
1679=item IO::AIO::poll_wait 1852=item IO::AIO::poll_wait
1680 1853
1681If there are any outstanding requests and none of them in the result 1854Wait until either at least one request is in the result phase or no
1682phase, wait till the result filehandle becomes ready for reading (simply 1855requests are outstanding anymore.
1683does a C<select> on the filehandle. This is useful if you want to 1856
1684synchronously wait for some requests to finish). 1857This is useful if you want to synchronously wait for some requests to
1858become ready, without actually handling them.
1685 1859
1686See C<nreqs> for an example. 1860See C<nreqs> for an example.
1687 1861
1688=item IO::AIO::poll 1862=item IO::AIO::poll
1689 1863
1810 1984
1811This is a very bad function to use in interactive programs because it 1985This is a very bad function to use in interactive programs because it
1812blocks, and a bad way to reduce concurrency because it is inexact: Better 1986blocks, and a bad way to reduce concurrency because it is inexact: Better
1813use an C<aio_group> together with a feed callback. 1987use an C<aio_group> together with a feed callback.
1814 1988
1815It's main use is in scripts without an event loop - when you want to stat 1989Its main use is in scripts without an event loop - when you want to stat
1816a lot of files, you can write somehting like this: 1990a lot of files, you can write somehting like this:
1817 1991
1818 IO::AIO::max_outstanding 32; 1992 IO::AIO::max_outstanding 32;
1819 1993
1820 for my $path (...) { 1994 for my $path (...) {
1860 2034
1861=back 2035=back
1862 2036
1863=head3 MISCELLANEOUS FUNCTIONS 2037=head3 MISCELLANEOUS FUNCTIONS
1864 2038
1865IO::AIO implements some functions that might be useful, but are not 2039IO::AIO implements some functions that are useful when you want to use
1866asynchronous. 2040some "Advanced I/O" function not available to in Perl, without going the
2041"Asynchronous I/O" route. Many of these have an asynchronous C<aio_*>
2042counterpart.
1867 2043
1868=over 4 2044=over 4
1869 2045
1870=item IO::AIO::sendfile $ofh, $ifh, $offset, $count 2046=item IO::AIO::sendfile $ofh, $ifh, $offset, $count
1871 2047
1890=item IO::AIO::madvise $scalar, $offset, $len, $advice 2066=item IO::AIO::madvise $scalar, $offset, $len, $advice
1891 2067
1892Simply calls the C<posix_madvise> function (see its 2068Simply calls the C<posix_madvise> function (see its
1893manpage for details). The following advice constants are 2069manpage for details). The following advice constants are
1894available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, 2070available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
1895C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>. 2071C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>,
2072C<IO::AIO::MADV_FREE>.
1896 2073
1897On systems that do not implement C<posix_madvise>, this function returns 2074On systems that do not implement C<posix_madvise>, this function returns
1898ENOSYS, otherwise the return value of C<posix_madvise>. 2075ENOSYS, otherwise the return value of C<posix_madvise>.
1899 2076
1900=item IO::AIO::mprotect $scalar, $offset, $len, $protect 2077=item IO::AIO::mprotect $scalar, $offset, $len, $protect
1908ENOSYS, otherwise the return value of C<mprotect>. 2085ENOSYS, otherwise the return value of C<mprotect>.
1909 2086
1910=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] 2087=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
1911 2088
1912Memory-maps a file (or anonymous memory range) and attaches it to the 2089Memory-maps a file (or anonymous memory range) and attaches it to the
1913given C<$scalar>, which will act like a string scalar. 2090given C<$scalar>, which will act like a string scalar. Returns true on
2091success, and false otherwise.
1914 2092
1915The only operations allowed on the scalar are C<substr>/C<vec> that don't 2093The only operations allowed on the scalar are C<substr>/C<vec> that don't
1916change the string length, and most read-only operations such as copying it 2094change the string length, and most read-only operations such as copying it
1917or searching it with regexes and so on. 2095or searching it with regexes and so on.
1918 2096
1929filesize. 2107filesize.
1930 2108
1931C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>, 2109C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,
1932C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>, 2110C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,
1933 2111
1934C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or 2112C<$flags> can be a combination of
1935C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when 2113C<IO::AIO::MAP_SHARED> or
1936not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS> 2114C<IO::AIO::MAP_PRIVATE>,
2115or a number of system-specific flags (when not available, the are C<0>):
1937(which is set to C<MAP_ANON> if your system only provides this 2116C<IO::AIO::MAP_ANONYMOUS> (which is set to C<MAP_ANON> if your system only provides this constant),
1938constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>, 2117C<IO::AIO::MAP_LOCKED>,
1939C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or 2118C<IO::AIO::MAP_NORESERVE>,
2119C<IO::AIO::MAP_POPULATE>,
1940C<IO::AIO::MAP_NONBLOCK> 2120C<IO::AIO::MAP_NONBLOCK>,
2121C<IO::AIO::MAP_FIXED>,
2122C<IO::AIO::MAP_GROWSDOWN>,
2123C<IO::AIO::MAP_32BIT>,
2124C<IO::AIO::MAP_HUGETLB> or
2125C<IO::AIO::MAP_STACK>.
1941 2126
1942If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed. 2127If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
1943 2128
1944C<$offset> is the offset from the start of the file - it generally must be 2129C<$offset> is the offset from the start of the file - it generally must be
1945a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>. 2130a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.
1977 2162
1978Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or 2163Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or
1979C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they 2164C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they
1980should be the file offset. 2165should be the file offset.
1981 2166
2167C<$r_fh> and C<$w_fh> should not refer to the same file, as splice might
2168silently corrupt the data in this case.
2169
1982The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>, 2170The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>,
1983C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and 2171C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and
1984C<IO::AIO::SPLICE_F_GIFT>. 2172C<IO::AIO::SPLICE_F_GIFT>.
1985 2173
1986See the C<splice(2)> manpage for details. 2174See the C<splice(2)> manpage for details.
1987 2175
1988=item IO::AIO::tee $r_fh, $w_fh, $length, $flags 2176=item IO::AIO::tee $r_fh, $w_fh, $length, $flags
1989 2177
1990Calls the GNU/Linux C<tee(2)> syscall, see it's manpage and the 2178Calls the GNU/Linux C<tee(2)> syscall, see its manpage and the
1991description for C<IO::AIO::splice> above for details. 2179description for C<IO::AIO::splice> above for details.
2180
2181=item $actual_size = IO::AIO::pipesize $r_fh[, $new_size]
2182
2183Attempts to query or change the pipe buffer size. Obviously works only
2184on pipes, and currently works only on GNU/Linux systems, and fails with
2185C<-1>/C<ENOSYS> everywhere else. If anybody knows how to influence pipe buffer
2186size on other systems, drop me a note.
2187
2188=item ($rfh, $wfh) = IO::AIO::pipe2 [$flags]
2189
2190This is a direct interface to the Linux L<pipe2(2)> system call. If
2191C<$flags> is missing or C<0>, then this should be the same as a call to
2192perl's built-in C<pipe> function and create a new pipe, and works on
2193systems that lack the pipe2 syscall. On win32, this case invokes C<_pipe
2194(..., 4096, O_BINARY)>.
2195
2196If C<$flags> is non-zero, it tries to invoke the pipe2 system call with
2197the given flags (Linux 2.6.27, glibc 2.9).
2198
2199On success, the read and write file handles are returned.
2200
2201On error, nothing will be returned. If the pipe2 syscall is missing and
2202C<$flags> is non-zero, fails with C<ENOSYS>.
2203
2204Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the
2205time of this writing, C<IO::AIO::O_CLOEXEC>, C<IO::AIO::O_NONBLOCK> and
2206C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported.
1992 2207
1993=back 2208=back
1994 2209
1995=cut 2210=cut
1996 2211

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines