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.208 by root, Mon Sep 26 20:19:08 2011 UTC vs.
Revision 1.242 by root, Sun Jan 6 11:48:13 2013 UTC

168use common::sense; 168use common::sense;
169 169
170use base 'Exporter'; 170use base 'Exporter';
171 171
172BEGIN { 172BEGIN {
173 our $VERSION = '4.0'; 173 our $VERSION = '4.19';
174 174
175 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close 175 our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close
176 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx 176 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx
177 aio_scandir aio_symlink aio_readlink aio_realpath aio_sync 177 aio_scandir aio_symlink aio_readlink aio_realpath aio_sync
178 aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_fallocate 178 aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_allocate
179 aio_pathsync aio_readahead 179 aio_pathsync aio_readahead aio_fiemap
180 aio_rename aio_link aio_move aio_copy aio_group 180 aio_rename aio_link aio_move aio_copy aio_group
181 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown 181 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
182 aio_chmod aio_utime aio_truncate 182 aio_chmod aio_utime aio_truncate
183 aio_msync aio_mtouch aio_mlock aio_mlockall 183 aio_msync aio_mtouch aio_mlock aio_mlockall
184 aio_statvfs 184 aio_statvfs
202 202
203=head1 FUNCTIONS 203=head1 FUNCTIONS
204 204
205=head2 QUICK OVERVIEW 205=head2 QUICK OVERVIEW
206 206
207This section simply lists the prototypes of the most important functions 207This section simply lists the prototypes most of the functions for
208for quick reference. See the following sections for function-by-function 208quick reference. See the following sections for function-by-function
209documentation. 209documentation.
210 210
211 aio_wd $pathname, $callback->($wd) 211 aio_wd $pathname, $callback->($wd)
212 aio_open $pathname, $flags, $mode, $callback->($fh) 212 aio_open $pathname, $flags, $mode, $callback->($fh)
213 aio_close $fh, $callback->($status) 213 aio_close $fh, $callback->($status)
214 aio_seek $fh,$offset,$whence, $callback->($offs)
214 aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 215 aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
215 aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 216 aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
216 aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) 217 aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
217 aio_readahead $fh,$offset,$length, $callback->($retval) 218 aio_readahead $fh,$offset,$length, $callback->($retval)
218 aio_stat $fh_or_path, $callback->($status) 219 aio_stat $fh_or_path, $callback->($status)
219 aio_lstat $fh, $callback->($status) 220 aio_lstat $fh, $callback->($status)
220 aio_statvfs $fh_or_path, $callback->($statvfs) 221 aio_statvfs $fh_or_path, $callback->($statvfs)
221 aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 222 aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
222 aio_chown $fh_or_path, $uid, $gid, $callback->($status) 223 aio_chown $fh_or_path, $uid, $gid, $callback->($status)
224 aio_chmod $fh_or_path, $mode, $callback->($status)
223 aio_truncate $fh_or_path, $offset, $callback->($status) 225 aio_truncate $fh_or_path, $offset, $callback->($status)
224 aio_chmod $fh_or_path, $mode, $callback->($status) 226 aio_allocate $fh, $mode, $offset, $len, $callback->($status)
227 aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
225 aio_unlink $pathname, $callback->($status) 228 aio_unlink $pathname, $callback->($status)
226 aio_mknod $path, $mode, $dev, $callback->($status) 229 aio_mknod $pathname, $mode, $dev, $callback->($status)
227 aio_link $srcpath, $dstpath, $callback->($status) 230 aio_link $srcpath, $dstpath, $callback->($status)
228 aio_symlink $srcpath, $dstpath, $callback->($status) 231 aio_symlink $srcpath, $dstpath, $callback->($status)
229 aio_readlink $path, $callback->($link) 232 aio_readlink $pathname, $callback->($link)
230 aio_realpath $path, $callback->($link) 233 aio_realpath $pathname, $callback->($link)
231 aio_rename $srcpath, $dstpath, $callback->($status) 234 aio_rename $srcpath, $dstpath, $callback->($status)
232 aio_mkdir $pathname, $mode, $callback->($status) 235 aio_mkdir $pathname, $mode, $callback->($status)
233 aio_rmdir $pathname, $callback->($status) 236 aio_rmdir $pathname, $callback->($status)
234 aio_readdir $pathname, $callback->($entries) 237 aio_readdir $pathname, $callback->($entries)
235 aio_readdirx $pathname, $flags, $callback->($entries, $flags) 238 aio_readdirx $pathname, $flags, $callback->($entries, $flags)
236 IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST 239 IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST
237 IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN 240 IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN
241 aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
238 aio_load $path, $data, $callback->($status) 242 aio_load $pathname, $data, $callback->($status)
239 aio_copy $srcpath, $dstpath, $callback->($status) 243 aio_copy $srcpath, $dstpath, $callback->($status)
240 aio_move $srcpath, $dstpath, $callback->($status) 244 aio_move $srcpath, $dstpath, $callback->($status)
241 aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
242 aio_rmtree $path, $callback->($status) 245 aio_rmtree $pathname, $callback->($status)
243 aio_sync $callback->($status) 246 aio_sync $callback->($status)
244 aio_syncfs $fh, $callback->($status) 247 aio_syncfs $fh, $callback->($status)
245 aio_fsync $fh, $callback->($status) 248 aio_fsync $fh, $callback->($status)
246 aio_fdatasync $fh, $callback->($status) 249 aio_fdatasync $fh, $callback->($status)
247 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) 250 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
248 aio_pathsync $path, $callback->($status) 251 aio_pathsync $pathname, $callback->($status)
249 aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 252 aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
250 aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 253 aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
251 aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) 254 aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
252 aio_mlockall $flags, $callback->($status) 255 aio_mlockall $flags, $callback->($status)
253 aio_group $callback->(...) 256 aio_group $callback->(...)
271 IO::AIO::nready 274 IO::AIO::nready
272 IO::AIO::npending 275 IO::AIO::npending
273 276
274 IO::AIO::sendfile $ofh, $ifh, $offset, $count 277 IO::AIO::sendfile $ofh, $ifh, $offset, $count
275 IO::AIO::fadvise $fh, $offset, $len, $advice 278 IO::AIO::fadvise $fh, $offset, $len, $advice
279 IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]
280 IO::AIO::munmap $scalar
276 IO::AIO::madvise $scalar, $offset, $length, $advice 281 IO::AIO::madvise $scalar, $offset, $length, $advice
277 IO::AIO::mprotect $scalar, $offset, $length, $protect 282 IO::AIO::mprotect $scalar, $offset, $length, $protect
278 IO::AIO::munlock $scalar, $offset = 0, $length = undef 283 IO::AIO::munlock $scalar, $offset = 0, $length = undef
279 IO::AIO::munlockall 284 IO::AIO::munlockall
280 285
281=head2 AIO REQUEST FUNCTIONS 286=head2 API NOTES
282 287
283All the C<aio_*> calls are more or less thin wrappers around the syscall 288All the C<aio_*> calls are more or less thin wrappers around the syscall
284with the same name (sans C<aio_>). The arguments are similar or identical, 289with the same name (sans C<aio_>). The arguments are similar or identical,
285and they all accept an additional (and optional) C<$callback> argument 290and they all accept an additional (and optional) C<$callback> argument
286which must be a code reference. This code reference will get called with 291which must be a code reference. This code reference will be called after
287the syscall return code (e.g. most syscalls return C<-1> on error, unlike 292the syscall has been executed in an asynchronous fashion. The results
288perl, which usually delivers "false") as its sole argument after the given 293of the request will be passed as arguments to the callback (and, if an
289syscall has been executed asynchronously. 294error occured, in C<$!>) - for most requests the syscall return code (e.g.
295most syscalls return C<-1> on error, unlike perl, which usually delivers
296"false").
297
298Some requests (such as C<aio_readdir>) pass the actual results and
299communicate failures by passing C<undef>.
290 300
291All functions expecting a filehandle keep a copy of the filehandle 301All functions expecting a filehandle keep a copy of the filehandle
292internally until the request has finished. 302internally until the request has finished.
293 303
294All functions return request objects of type L<IO::AIO::REQ> that allow 304All functions return request objects of type L<IO::AIO::REQ> that allow
295further manipulation of those requests while they are in-flight. 305further manipulation of those requests while they are in-flight.
296 306
297The pathnames you pass to these routines I<must> be absolute and 307The pathnames you pass to these routines I<should> be absolute. The
298encoded as octets. The reason for the former is that at the time the 308reason for this is that at the time the request is being executed, the
299request is being executed, the current working directory could have 309current working directory could have changed. Alternatively, you can
300changed. Alternatively, you can make sure that you never change the 310make sure that you never change the current working directory anywhere
301current working directory anywhere in the program and then use relative 311in the program and then use relative paths. You can also take advantage
302paths. 312of IO::AIOs working directory abstraction, that lets you specify paths
313relative to some previously-opened "working directory object" - see the
314description of the C<IO::AIO::WD> class later in this document.
303 315
304To encode pathnames as octets, either make sure you either: a) always pass 316To encode pathnames as octets, either make sure you either: a) always pass
305in filenames you got from outside (command line, readdir etc.) without 317in filenames you got from outside (command line, readdir etc.) without
306tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module and encode 318tinkering, b) are in your native filesystem encoding, c) use the Encode
307your pathnames to the locale (or other) encoding in effect in the user 319module and encode your pathnames to the locale (or other) encoding in
308environment, d) use Glib::filename_from_unicode on unicode filenames or e) 320effect in the user environment, d) use Glib::filename_from_unicode on
309use something else to ensure your scalar has the correct contents. 321unicode filenames or e) use something else to ensure your scalar has the
322correct contents.
310 323
311This works, btw. independent of the internal UTF-8 bit, which IO::AIO 324This works, btw. independent of the internal UTF-8 bit, which IO::AIO
312handles correctly whether it is set or not. 325handles correctly whether it is set or not.
326
327=head2 AIO REQUEST FUNCTIONS
313 328
314=over 4 329=over 4
315 330
316=item $prev_pri = aioreq_pri [$pri] 331=item $prev_pri = aioreq_pri [$pri]
317 332
347 362
348 363
349=item aio_open $pathname, $flags, $mode, $callback->($fh) 364=item aio_open $pathname, $flags, $mode, $callback->($fh)
350 365
351Asynchronously open or create a file and call the callback with a newly 366Asynchronously open or create a file and call the callback with a newly
352created filehandle for the file. 367created filehandle for the file (or C<undef> in case of an error).
353 368
354The pathname passed to C<aio_open> must be absolute. See API NOTES, above, 369The pathname passed to C<aio_open> must be absolute. See API NOTES, above,
355for an explanation. 370for an explanation.
356 371
357The C<$flags> argument is a bitmask. See the C<Fcntl> module for a 372The C<$flags> argument is a bitmask. See the C<Fcntl> module for a
399 414
400Or in other words: the file descriptor will be closed, but it will not be 415Or in other words: the file descriptor will be closed, but it will not be
401free for reuse until the perl filehandle is closed. 416free for reuse until the perl filehandle is closed.
402 417
403=cut 418=cut
419
420=item aio_seek $fh, $offset, $whence, $callback->($offs)
421
422Seeks the filehandle to the new C<$offset>, similarly to perl's
423C<sysseek>. The C<$whence> can use the traditional values (C<0> for
424C<IO::AIO::SEEK_SET>, C<1> for C<IO::AIO::SEEK_CUR> or C<2> for
425C<IO::AIO::SEEK_END>).
426
427The resulting absolute offset will be passed to the callback, or C<-1> in
428case of an error.
429
430In theory, the C<$whence> constants could be different than the
431corresponding values from L<Fcntl>, but perl guarantees they are the same,
432so don't panic.
433
434As a GNU/Linux (and maybe Solaris) extension, also the constants
435C<IO::AIO::SEEK_DATA> and C<IO::AIO::SEEK_HOLE> are available, if they
436could be found. No guarantees about suitability for use in C<aio_seek> or
437Perl's C<sysseek> can be made though, although I would naively assume they
438"just work".
404 439
405=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 440=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
406 441
407=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 442=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
408 443
568 namemax => 255, 603 namemax => 255,
569 frsize => 1024, 604 frsize => 1024,
570 fsid => 1810 605 fsid => 1810
571 } 606 }
572 607
608Here is a (likely partial) list of fsid values used by Linux - it is safe
609to hardcode these when the $^O is C<linux>:
610
611 0x0000adf5 adfs
612 0x0000adff affs
613 0x5346414f afs
614 0x09041934 anon-inode filesystem
615 0x00000187 autofs
616 0x42465331 befs
617 0x1badface bfs
618 0x42494e4d binfmt_misc
619 0x9123683e btrfs
620 0x0027e0eb cgroupfs
621 0xff534d42 cifs
622 0x73757245 coda
623 0x012ff7b7 coh
624 0x28cd3d45 cramfs
625 0x453dcd28 cramfs-wend (wrong endianness)
626 0x64626720 debugfs
627 0x00001373 devfs
628 0x00001cd1 devpts
629 0x0000f15f ecryptfs
630 0x00414a53 efs
631 0x0000137d ext
632 0x0000ef53 ext2/ext3
633 0x0000ef51 ext2
634 0x00004006 fat
635 0x65735546 fuseblk
636 0x65735543 fusectl
637 0x0bad1dea futexfs
638 0x01161970 gfs2
639 0x47504653 gpfs
640 0x00004244 hfs
641 0xf995e849 hpfs
642 0x958458f6 hugetlbfs
643 0x2bad1dea inotifyfs
644 0x00009660 isofs
645 0x000072b6 jffs2
646 0x3153464a jfs
647 0x6b414653 k-afs
648 0x0bd00bd0 lustre
649 0x0000137f minix
650 0x0000138f minix 30 char names
651 0x00002468 minix v2
652 0x00002478 minix v2 30 char names
653 0x00004d5a minix v3
654 0x19800202 mqueue
655 0x00004d44 msdos
656 0x0000564c novell
657 0x00006969 nfs
658 0x6e667364 nfsd
659 0x00003434 nilfs
660 0x5346544e ntfs
661 0x00009fa1 openprom
662 0x7461636F ocfs2
663 0x00009fa0 proc
664 0x6165676c pstorefs
665 0x0000002f qnx4
666 0x858458f6 ramfs
667 0x52654973 reiserfs
668 0x00007275 romfs
669 0x67596969 rpc_pipefs
670 0x73636673 securityfs
671 0xf97cff8c selinux
672 0x0000517b smb
673 0x534f434b sockfs
674 0x73717368 squashfs
675 0x62656572 sysfs
676 0x012ff7b6 sysv2
677 0x012ff7b5 sysv4
678 0x01021994 tmpfs
679 0x15013346 udf
680 0x00011954 ufs
681 0x54190100 ufs byteswapped
682 0x00009fa2 usbdevfs
683 0x01021997 v9fs
684 0xa501fcf5 vxfs
685 0xabba1974 xenfs
686 0x012ff7b4 xenix
687 0x58465342 xfs
688 0x012fd16d xia
573 689
574=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 690=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
575 691
576Works like perl's C<utime> function (including the special case of $atime 692Works like perl's C<utime> function (including the special case of $atime
577and $mtime being undef). Fractional times are supported if the underlying 693and $mtime being undef). Fractional times are supported if the underlying
605=item aio_truncate $fh_or_path, $offset, $callback->($status) 721=item aio_truncate $fh_or_path, $offset, $callback->($status)
606 722
607Works like truncate(2) or ftruncate(2). 723Works like truncate(2) or ftruncate(2).
608 724
609 725
726=item aio_allocate $fh, $mode, $offset, $len, $callback->($status)
727
728Allocates or freed disk space according to the C<$mode> argument. See the
729linux C<fallocate> docuemntation for details.
730
731C<$mode> can currently be C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE>
732to allocate space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE |
733IO::AIO::FALLOC_FL_KEEP_SIZE>, to deallocate a file range.
734
735The file system block size used by C<fallocate> is presumably the
736C<f_bsize> returned by C<statvfs>.
737
738If C<fallocate> isn't available or cannot be emulated (currently no
739emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>.
740
741
610=item aio_chmod $fh_or_path, $mode, $callback->($status) 742=item aio_chmod $fh_or_path, $mode, $callback->($status)
611 743
612Works like perl's C<chmod> function. 744Works like perl's C<chmod> function.
613 745
614 746
616 748
617Asynchronously unlink (delete) a file and call the callback with the 749Asynchronously unlink (delete) a file and call the callback with the
618result code. 750result code.
619 751
620 752
621=item aio_mknod $path, $mode, $dev, $callback->($status) 753=item aio_mknod $pathname, $mode, $dev, $callback->($status)
622 754
623[EXPERIMENTAL] 755[EXPERIMENTAL]
624 756
625Asynchronously create a device node (or fifo). See mknod(2). 757Asynchronously create a device node (or fifo). See mknod(2).
626 758
627The only (POSIX-) portable way of calling this function is: 759The only (POSIX-) portable way of calling this function is:
628 760
629 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... 761 aio_mknod $pathname, IO::AIO::S_IFIFO | $mode, 0, sub { ...
630 762
631See C<aio_stat> for info about some potentially helpful extra constants 763See C<aio_stat> for info about some potentially helpful extra constants
632and functions. 764and functions.
633 765
634=item aio_link $srcpath, $dstpath, $callback->($status) 766=item aio_link $srcpath, $dstpath, $callback->($status)
641 773
642Asynchronously create a new symbolic link to the existing object at C<$srcpath> at 774Asynchronously create a new symbolic link to the existing object at C<$srcpath> at
643the path C<$dstpath> and call the callback with the result code. 775the path C<$dstpath> and call the callback with the result code.
644 776
645 777
646=item aio_readlink $path, $callback->($link) 778=item aio_readlink $pathname, $callback->($link)
647 779
648Asynchronously read the symlink specified by C<$path> and pass it to 780Asynchronously read the symlink specified by C<$path> and pass it to
649the callback. If an error occurs, nothing or undef gets passed to the 781the callback. If an error occurs, nothing or undef gets passed to the
650callback. 782callback.
651 783
652 784
653=item aio_realpath $path, $callback->($path) 785=item aio_realpath $pathname, $callback->($path)
654 786
655Asynchronously make the path absolute and resolve any symlinks in 787Asynchronously make the path absolute and resolve any symlinks in
656C<$path>. The resulting path only consists of directories (Same as 788C<$path>. The resulting path only consists of directories (same as
657L<Cwd::realpath>). 789L<Cwd::realpath>).
658 790
659This request can be used to get the absolute path of the current working 791This request can be used to get the absolute path of the current working
660directory by passing it a path of F<.> (a single dot). 792directory by passing it a path of F<.> (a single dot).
661 793
662 794
663=item aio_rename $srcpath, $dstpath, $callback->($status) 795=item aio_rename $srcpath, $dstpath, $callback->($status)
664 796
665Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as 797Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
666rename(2) and call the callback with the result code. 798rename(2) and call the callback with the result code.
799
800On systems that support the AIO::WD working directory abstraction
801natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead
802of failing, C<rename> is called on the absolute path of C<$wd>.
667 803
668 804
669=item aio_mkdir $pathname, $mode, $callback->($status) 805=item aio_mkdir $pathname, $mode, $callback->($status)
670 806
671Asynchronously mkdir (create) a directory and call the callback with 807Asynchronously mkdir (create) a directory and call the callback with
675 811
676=item aio_rmdir $pathname, $callback->($status) 812=item aio_rmdir $pathname, $callback->($status)
677 813
678Asynchronously rmdir (delete) a directory and call the callback with the 814Asynchronously rmdir (delete) a directory and call the callback with the
679result code. 815result code.
816
817On systems that support the AIO::WD working directory abstraction
818natively, the case C<[$wd, "."]> is specialcased - instead of failing,
819C<rmdir> is called on the absolute path of C<$wd>.
680 820
681 821
682=item aio_readdir $pathname, $callback->($entries) 822=item aio_readdir $pathname, $callback->($entries)
683 823
684Unlike the POSIX call of the same name, C<aio_readdir> reads an entire 824Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
753C<$type>'s are known, which can be used to speed up some algorithms. 893C<$type>'s are known, which can be used to speed up some algorithms.
754 894
755=back 895=back
756 896
757 897
758=item aio_load $path, $data, $callback->($status) 898=item aio_load $pathname, $data, $callback->($status)
759 899
760This is a composite request that tries to fully load the given file into 900This is a composite request that tries to fully load the given file into
761memory. Status is the same as with aio_read. 901memory. Status is the same as with aio_read.
762 902
763=cut 903=cut
898 }; 1038 };
899 1039
900 $grp 1040 $grp
901} 1041}
902 1042
903=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 1043=item aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
904 1044
905Scans a directory (similar to C<aio_readdir>) but additionally tries to 1045Scans a directory (similar to C<aio_readdir>) but additionally tries to
906efficiently separate the entries of directory C<$path> into two sets of 1046efficiently separate the entries of directory C<$path> into two sets of
907names, directories you can recurse into (directories), and ones you cannot 1047names, directories you can recurse into (directories), and ones you cannot
908recurse into (everything else, including symlinks to directories). 1048recurse into (everything else, including symlinks to directories).
965 1105
966 my $grp = aio_group $cb; 1106 my $grp = aio_group $cb;
967 1107
968 $maxreq = 4 if $maxreq <= 0; 1108 $maxreq = 4 if $maxreq <= 0;
969 1109
970 # stat once 1110 # get a wd object
971 aioreq_pri $pri; 1111 aioreq_pri $pri;
972 add $grp aio_stat $path, sub { 1112 add $grp aio_wd $path, sub {
1113 $_[0]
973 return $grp->result () if $_[0]; 1114 or return $grp->result ();
974 my $now = time;
975 my $hash1 = join ":", (stat _)[0,1,3,7,9];
976 1115
977 # read the directory entries 1116 my $wd = [shift, "."];
1117
1118 # stat once
978 aioreq_pri $pri; 1119 aioreq_pri $pri;
979 add $grp aio_readdirx $path, READDIR_DIRS_FIRST, sub { 1120 add $grp aio_stat $wd, sub {
980 my $entries = shift
981 or return $grp->result (); 1121 return $grp->result () if $_[0];
1122 my $now = time;
1123 my $hash1 = join ":", (stat _)[0,1,3,7,9];
982 1124
983 # stat the dir another time 1125 # read the directory entries
984 aioreq_pri $pri; 1126 aioreq_pri $pri;
1127 add $grp aio_readdirx $wd, READDIR_DIRS_FIRST, sub {
1128 my $entries = shift
1129 or return $grp->result ();
1130
1131 # stat the dir another time
1132 aioreq_pri $pri;
985 add $grp aio_stat $path, sub { 1133 add $grp aio_stat $wd, sub {
986 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 1134 my $hash2 = join ":", (stat _)[0,1,3,7,9];
987 1135
988 my $ndirs; 1136 my $ndirs;
989 1137
990 # take the slow route if anything looks fishy 1138 # take the slow route if anything looks fishy
991 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 1139 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
992 $ndirs = -1; 1140 $ndirs = -1;
993 } else { 1141 } else {
994 # if nlink == 2, we are finished 1142 # if nlink == 2, we are finished
995 # for non-posix-fs's, we rely on nlink < 2 1143 # for non-posix-fs's, we rely on nlink < 2
996 $ndirs = (stat _)[3] - 2 1144 $ndirs = (stat _)[3] - 2
997 or return $grp->result ([], $entries); 1145 or return $grp->result ([], $entries);
998 } 1146 }
999 1147
1000 my (@dirs, @nondirs); 1148 my (@dirs, @nondirs);
1001 1149
1002 my $statgrp = add $grp aio_group sub { 1150 my $statgrp = add $grp aio_group sub {
1003 $grp->result (\@dirs, \@nondirs); 1151 $grp->result (\@dirs, \@nondirs);
1004 }; 1152 };
1005 1153
1006 limit $statgrp $maxreq; 1154 limit $statgrp $maxreq;
1007 feed $statgrp sub { 1155 feed $statgrp sub {
1008 return unless @$entries; 1156 return unless @$entries;
1009 my $entry = shift @$entries; 1157 my $entry = shift @$entries;
1010 1158
1011 aioreq_pri $pri; 1159 aioreq_pri $pri;
1160 $wd->[1] = "$entry/.";
1012 add $statgrp aio_stat "$path/$entry/.", sub { 1161 add $statgrp aio_stat $wd, sub {
1013 if ($_[0] < 0) { 1162 if ($_[0] < 0) {
1014 push @nondirs, $entry; 1163 push @nondirs, $entry;
1015 } else { 1164 } else {
1016 # need to check for real directory 1165 # need to check for real directory
1017 aioreq_pri $pri; 1166 aioreq_pri $pri;
1167 $wd->[1] = $entry;
1018 add $statgrp aio_lstat "$path/$entry", sub { 1168 add $statgrp aio_lstat $wd, sub {
1019 if (-d _) { 1169 if (-d _) {
1020 push @dirs, $entry; 1170 push @dirs, $entry;
1021 1171
1022 unless (--$ndirs) { 1172 unless (--$ndirs) {
1023 push @nondirs, @$entries; 1173 push @nondirs, @$entries;
1024 feed $statgrp; 1174 feed $statgrp;
1175 }
1176 } else {
1177 push @nondirs, $entry;
1025 } 1178 }
1026 } else {
1027 push @nondirs, $entry;
1028 } 1179 }
1029 } 1180 }
1030 } 1181 };
1031 }; 1182 };
1032 }; 1183 };
1033 }; 1184 };
1034 }; 1185 };
1035 }; 1186 };
1036 1187
1037 $grp 1188 $grp
1038} 1189}
1039 1190
1040=item aio_rmtree $path, $callback->($status) 1191=item aio_rmtree $pathname, $callback->($status)
1041 1192
1042Delete a directory tree starting (and including) C<$path>, return the 1193Delete a directory tree starting (and including) C<$path>, return the
1043status of the final C<rmdir> only. This is a composite request that 1194status of the final C<rmdir> only. This is a composite request that
1044uses C<aio_scandir> to recurse into and rmdir directories, and unlink 1195uses C<aio_scandir> to recurse into and rmdir directories, and unlink
1045everything else. 1196everything else.
1046 1197
1047=cut 1198=cut
1048 1199
1106C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>, 1257C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,
1107C<IO::AIO::SYNC_FILE_RANGE_WRITE> and 1258C<IO::AIO::SYNC_FILE_RANGE_WRITE> and
1108C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range 1259C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range
1109manpage for details. 1260manpage for details.
1110 1261
1111=item aio_pathsync $path, $callback->($status) 1262=item aio_pathsync $pathname, $callback->($status)
1112 1263
1113This request tries to open, fsync and close the given path. This is a 1264This request tries to open, fsync and close the given path. This is a
1114composite request intended to sync directories after directory operations 1265composite request intended to sync directories after directory operations
1115(E.g. rename). This might not work on all operating systems or have any 1266(E.g. rename). This might not work on all operating systems or have any
1116specific effect, but usually it makes sure that directory changes get 1267specific effect, but usually it makes sure that directory changes get
1168 1319
1169This is a rather advanced IO::AIO call, which works best on mmap(2)ed 1320This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1170scalars. 1321scalars.
1171 1322
1172It touches (reads or writes) all memory pages in the specified 1323It touches (reads or writes) all memory pages in the specified
1173range inside the scalar. All caveats and parameters are the same 1324range inside the scalar. All caveats and parameters are the same
1174as for C<aio_msync>, above, except for flags, which must be either 1325as for C<aio_msync>, above, except for flags, which must be either
1175C<0> (which reads all pages and ensures they are instantiated) or 1326C<0> (which reads all pages and ensures they are instantiated) or
1176C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and 1327C<IO::AIO::MT_MODIFY>, which modifies the memory pages (by reading and
1177writing an octet from it, which dirties the page). 1328writing an octet from it, which dirties the page).
1178 1329
1179=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) 1330=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
1180 1331
1181This is a rather advanced IO::AIO call, which works best on mmap(2)ed 1332This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1212documented under L<MISCELLANEOUS FUNCTIONS>. 1363documented under L<MISCELLANEOUS FUNCTIONS>.
1213 1364
1214Example: asynchronously lock all current and future pages into memory. 1365Example: asynchronously lock all current and future pages into memory.
1215 1366
1216 aio_mlockall IO::AIO::MCL_FUTURE; 1367 aio_mlockall IO::AIO::MCL_FUTURE;
1368
1369=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
1370
1371Queries the extents of the given file (by calling the Linux C<FIEMAP>
1372ioctl, see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If
1373the ioctl is not available on your OS, then this request will fail with
1374C<ENOSYS>.
1375
1376C<$start> is the starting offset to query extents for, C<$length> is the
1377size of the range to query - if it is C<undef>, then the whole file will
1378be queried.
1379
1380C<$flags> is a combination of flags (C<IO::AIO::FIEMAP_FLAG_SYNC> or
1381C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also
1382exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query
1383the data portion.
1384
1385C<$count> is the maximum number of extent records to return. If it is
1386C<undef>, then IO::AIO queries all extents of the range. As a very special
1387case, if it is C<0>, then the callback receives the number of extents
1388instead of the extents themselves (which is unreliable, see below).
1389
1390If an error occurs, the callback receives no arguments. The special
1391C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.
1392
1393Otherwise, the callback receives an array reference with extent
1394structures. Each extent structure is an array reference itself, with the
1395following members:
1396
1397 [$logical, $physical, $length, $flags]
1398
1399Flags is any combination of the following flag values (typically either C<0>
1400or C<IO::AIO::FIEMAP_EXTENT_LAST> (1)):
1401
1402C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,
1403C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,
1404C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,
1405C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,
1406C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or
1407C<IO::AIO::FIEMAP_EXTENT_SHARED>.
1408
1409At the time of this writing (Linux 3.2), this requets is unreliable unless
1410C<$count> is C<undef>, as the kernel has all sorts of bugs preventing
1411it to return all extents of a range for files with large number of
1412extents. The code works around all these issues if C<$count> is undef.
1217 1413
1218=item aio_group $callback->(...) 1414=item aio_group $callback->(...)
1219 1415
1220This is a very special aio request: Instead of doing something, it is a 1416This is a very special aio request: Instead of doing something, it is a
1221container for other aio requests, which is useful if you want to bundle 1417container for other aio requests, which is useful if you want to bundle
1258like sleep and file handle readable/writable, the overhead this creates is 1454like sleep and file handle readable/writable, the overhead this creates is
1259immense (it blocks a thread for a long time) so do not use this function 1455immense (it blocks a thread for a long time) so do not use this function
1260except to put your application under artificial I/O pressure. 1456except to put your application under artificial I/O pressure.
1261 1457
1262=back 1458=back
1459
1460
1461=head2 IO::AIO::WD - multiple working directories
1462
1463Your process only has one current working directory, which is used by all
1464threads. This makes it hard to use relative paths (some other component
1465could call C<chdir> at any time, and it is hard to control when the path
1466will be used by IO::AIO).
1467
1468One solution for this is to always use absolute paths. This usually works,
1469but can be quite slow (the kernel has to walk the whole path on every
1470access), and can also be a hassle to implement.
1471
1472Newer POSIX systems have a number of functions (openat, fdopendir,
1473futimensat and so on) that make it possible to specify working directories
1474per operation.
1475
1476For portability, and because the clowns who "designed", or shall I write,
1477perpetrated this new interface were obviously half-drunk, this abstraction
1478cannot be perfect, though.
1479
1480IO::AIO allows you to convert directory paths into a so-called IO::AIO::WD
1481object. This object stores the canonicalised, absolute version of the
1482path, and on systems that allow it, also a directory file descriptor.
1483
1484Everywhere where a pathname is accepted by IO::AIO (e.g. in C<aio_stat>
1485or C<aio_unlink>), one can specify an array reference with an IO::AIO::WD
1486object and a pathname instead (or the IO::AIO::WD object alone, which
1487gets interpreted as C<[$wd, "."]>). If the pathname is absolute, the
1488IO::AIO::WD object is ignored, otherwise the pathname is resolved relative
1489to that IO::AIO::WD object.
1490
1491For example, to get a wd object for F</etc> and then stat F<passwd>
1492inside, you would write:
1493
1494 aio_wd "/etc", sub {
1495 my $etcdir = shift;
1496
1497 # although $etcdir can be undef on error, there is generally no reason
1498 # to check for errors here, as aio_stat will fail with ENOENT
1499 # when $etcdir is undef.
1500
1501 aio_stat [$etcdir, "passwd"], sub {
1502 # yay
1503 };
1504 };
1505
1506That C<aio_wd> is a request and not a normal function shows that creating
1507an IO::AIO::WD object is itself a potentially blocking operation, which is
1508why it is done asynchronously.
1509
1510To stat the directory obtained with C<aio_wd> above, one could write
1511either of the following three request calls:
1512
1513 aio_lstat "/etc" , sub { ... # pathname as normal string
1514 aio_lstat [$wd, "."], sub { ... # "." relative to $wd (i.e. $wd itself)
1515 aio_lstat $wd , sub { ... # shorthand for the previous
1516
1517As with normal pathnames, IO::AIO keeps a copy of the working directory
1518object and the pathname string, so you could write the following without
1519causing any issues due to C<$path> getting reused:
1520
1521 my $path = [$wd, undef];
1522
1523 for my $name (qw(abc def ghi)) {
1524 $path->[1] = $name;
1525 aio_stat $path, sub {
1526 # ...
1527 };
1528 }
1529
1530There are some caveats: when directories get renamed (or deleted), the
1531pathname string doesn't change, so will point to the new directory (or
1532nowhere at all), while the directory fd, if available on the system,
1533will still point to the original directory. Most functions accepting a
1534pathname will use the directory fd on newer systems, and the string on
1535older systems. Some functions (such as realpath) will always rely on the
1536string form of the pathname.
1537
1538So this functionality is mainly useful to get some protection against
1539C<chdir>, to easily get an absolute path out of a relative path for future
1540reference, and to speed up doing many operations in the same directory
1541(e.g. when stat'ing all files in a directory).
1542
1543The following functions implement this working directory abstraction:
1544
1545=over 4
1546
1547=item aio_wd $pathname, $callback->($wd)
1548
1549Asynchonously canonicalise the given pathname and convert it to an
1550IO::AIO::WD object representing it. If possible and supported on the
1551system, also open a directory fd to speed up pathname resolution relative
1552to this working directory.
1553
1554If something goes wrong, then C<undef> is passwd to the callback instead
1555of a working directory object and C<$!> is set appropriately. Since
1556passing C<undef> as working directory component of a pathname fails the
1557request with C<ENOENT>, there is often no need for error checking in the
1558C<aio_wd> callback, as future requests using the value will fail in the
1559expected way.
1560
1561If this call isn't available because your OS lacks it or it couldn't be
1562detected, it will be emulated by calling C<fsync> instead.
1563
1564=item IO::AIO::CWD
1565
1566This is a compiletime constant (object) that represents the process
1567current working directory.
1568
1569Specifying this object as working directory object for a pathname is as if
1570the pathname would be specified directly, without a directory object. For
1571example, these calls are functionally identical:
1572
1573 aio_stat "somefile", sub { ... };
1574 aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
1575
1576=back
1577
1578To recover the path associated with an IO::AIO::WD object, you can use
1579C<aio_realpath>:
1580
1581 aio_realpath $wd, sub {
1582 warn "path is $_[0]\n";
1583 };
1584
1585Currently, C<aio_statvfs> always, and C<aio_rename> and C<aio_rmdir>
1586sometimes, fall back to using an absolue path.
1263 1587
1264=head2 IO::AIO::REQ CLASS 1588=head2 IO::AIO::REQ CLASS
1265 1589
1266All non-aggregate C<aio_*> functions return an object of this class when 1590All non-aggregate C<aio_*> functions return an object of this class when
1267called in non-void context. 1591called in non-void context.
1385 1709
1386Sets a feeder/generator on this group: every group can have an attached 1710Sets a feeder/generator on this group: every group can have an attached
1387generator that generates requests if idle. The idea behind this is that, 1711generator that generates requests if idle. The idea behind this is that,
1388although you could just queue as many requests as you want in a group, 1712although you could just queue as many requests as you want in a group,
1389this might starve other requests for a potentially long time. For example, 1713this might starve other requests for a potentially long time. For example,
1390C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests, 1714C<aio_scandir> might generate hundreds of thousands of C<aio_stat>
1391delaying any later requests for a long time. 1715requests, delaying any later requests for a long time.
1392 1716
1393To avoid this, and allow incremental generation of requests, you can 1717To avoid this, and allow incremental generation of requests, you can
1394instead a group and set a feeder on it that generates those requests. The 1718instead a group and set a feeder on it that generates those requests. The
1395feed callback will be called whenever there are few enough (see C<limit>, 1719feed callback will be called whenever there are few enough (see C<limit>,
1396below) requests active in the group itself and is expected to queue more 1720below) requests active in the group itself and is expected to queue more
1445 1769
1446See C<poll_cb> for an example. 1770See C<poll_cb> for an example.
1447 1771
1448=item IO::AIO::poll_cb 1772=item IO::AIO::poll_cb
1449 1773
1450Process some outstanding events on the result pipe. You have to call 1774Process some requests that have reached the result phase (i.e. they have
1775been executed but the results are not yet reported). You have to call
1776this "regularly" to finish outstanding requests.
1777
1451this regularly. Returns C<0> if all events could be processed (or there 1778Returns C<0> if all events could be processed (or there were no
1452were no events to process), or C<-1> if it returned earlier for whatever 1779events to process), or C<-1> if it returned earlier for whatever
1453reason. Returns immediately when no events are outstanding. The amount of 1780reason. Returns immediately when no events are outstanding. The amount
1454events processed depends on the settings of C<IO::AIO::max_poll_req> and 1781of events processed depends on the settings of C<IO::AIO::max_poll_req>,
1455C<IO::AIO::max_poll_time>. 1782C<IO::AIO::max_poll_time> and C<IO::AIO::max_outstanding>.
1456 1783
1457If not all requests were processed for whatever reason, the filehandle 1784If not all requests were processed for whatever reason, the poll file
1458will still be ready when C<poll_cb> returns, so normally you don't have to 1785descriptor will still be ready when C<poll_cb> returns, so normally you
1459do anything special to have it called later. 1786don't have to do anything special to have it called later.
1460 1787
1461Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes 1788Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes
1462ready, it can be beneficial to call this function from loops which submit 1789ready, it can be beneficial to call this function from loops which submit
1463a lot of requests, to make sure the results get processed when they become 1790a lot of requests, to make sure the results get processed when they become
1464available and not just when the loop is finished and the event loop takes 1791available and not just when the loop is finished and the event loop takes
1473 poll => 'r', async => 1, 1800 poll => 'r', async => 1,
1474 cb => \&IO::AIO::poll_cb); 1801 cb => \&IO::AIO::poll_cb);
1475 1802
1476=item IO::AIO::poll_wait 1803=item IO::AIO::poll_wait
1477 1804
1478If there are any outstanding requests and none of them in the result 1805Wait until either at least one request is in the result phase or no
1479phase, wait till the result filehandle becomes ready for reading (simply 1806requests are outstanding anymore.
1480does a C<select> on the filehandle. This is useful if you want to 1807
1481synchronously wait for some requests to finish). 1808This is useful if you want to synchronously wait for some requests to
1809become ready, without actually handling them.
1482 1810
1483See C<nreqs> for an example. 1811See C<nreqs> for an example.
1484 1812
1485=item IO::AIO::poll 1813=item IO::AIO::poll
1486 1814
1705ENOSYS, otherwise the return value of C<mprotect>. 2033ENOSYS, otherwise the return value of C<mprotect>.
1706 2034
1707=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] 2035=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
1708 2036
1709Memory-maps a file (or anonymous memory range) and attaches it to the 2037Memory-maps a file (or anonymous memory range) and attaches it to the
1710given C<$scalar>, which will act like a string scalar. 2038given C<$scalar>, which will act like a string scalar. Returns true on
2039success, and false otherwise.
1711 2040
1712The only operations allowed on the scalar are C<substr>/C<vec> that don't 2041The only operations allowed on the scalar are C<substr>/C<vec> that don't
1713change the string length, and most read-only operations such as copying it 2042change the string length, and most read-only operations such as copying it
1714or searching it with regexes and so on. 2043or searching it with regexes and so on.
1715 2044
1768Calls the C<munlockall> function. 2097Calls the C<munlockall> function.
1769 2098
1770On systems that do not implement C<munlockall>, this function returns 2099On systems that do not implement C<munlockall>, this function returns
1771ENOSYS, otherwise the return value of C<munlockall>. 2100ENOSYS, otherwise the return value of C<munlockall>.
1772 2101
2102=item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
2103
2104Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or
2105C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they
2106should be the file offset.
2107
2108C<$r_fh> and C<$w_fh> should not refer to the same file, as splice might
2109silently corrupt the data in this case.
2110
2111The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>,
2112C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and
2113C<IO::AIO::SPLICE_F_GIFT>.
2114
2115See the C<splice(2)> manpage for details.
2116
2117=item IO::AIO::tee $r_fh, $w_fh, $length, $flags
2118
2119Calls the GNU/Linux C<tee(2)> syscall, see it's manpage and the
2120description for C<IO::AIO::splice> above for details.
2121
1773=back 2122=back
1774 2123
1775=cut 2124=cut
1776 2125
1777min_parallel 8; 2126min_parallel 8;

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines