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.207 by root, Mon Jul 25 16:50:33 2011 UTC vs.
Revision 1.239 by root, Thu Dec 13 02:26:28 2012 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.18';
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
185 aio_wd);
185 186
186 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); 187 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
187 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 188 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
188 min_parallel max_parallel max_idle idle_timeout 189 min_parallel max_parallel max_idle idle_timeout
189 nreqs nready npending nthreads 190 nreqs nready npending nthreads
… …
201 202
202=head1 FUNCTIONS 203=head1 FUNCTIONS
203 204
204=head2 QUICK OVERVIEW 205=head2 QUICK OVERVIEW
205 206
206This section simply lists the prototypes of the most important functions 207This section simply lists the prototypes most of the functions for
207for quick reference. See the following sections for function-by-function 208quick reference. See the following sections for function-by-function
208documentation. 209documentation.
209 210
211 aio_wd $pathname, $callback->($wd)
210 aio_open $pathname, $flags, $mode, $callback->($fh) 212 aio_open $pathname, $flags, $mode, $callback->($fh)
211 aio_close $fh, $callback->($status) 213 aio_close $fh, $callback->($status)
214 aio_seek $fh,$offset,$whence, $callback->($offs)
212 aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 215 aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
213 aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 216 aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
214 aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) 217 aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
215 aio_readahead $fh,$offset,$length, $callback->($retval) 218 aio_readahead $fh,$offset,$length, $callback->($retval)
216 aio_stat $fh_or_path, $callback->($status) 219 aio_stat $fh_or_path, $callback->($status)
217 aio_lstat $fh, $callback->($status) 220 aio_lstat $fh, $callback->($status)
218 aio_statvfs $fh_or_path, $callback->($statvfs) 221 aio_statvfs $fh_or_path, $callback->($statvfs)
219 aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 222 aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
220 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)
221 aio_truncate $fh_or_path, $offset, $callback->($status) 225 aio_truncate $fh_or_path, $offset, $callback->($status)
222 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)
223 aio_unlink $pathname, $callback->($status) 228 aio_unlink $pathname, $callback->($status)
224 aio_mknod $path, $mode, $dev, $callback->($status) 229 aio_mknod $pathname, $mode, $dev, $callback->($status)
225 aio_link $srcpath, $dstpath, $callback->($status) 230 aio_link $srcpath, $dstpath, $callback->($status)
226 aio_symlink $srcpath, $dstpath, $callback->($status) 231 aio_symlink $srcpath, $dstpath, $callback->($status)
227 aio_readlink $path, $callback->($link) 232 aio_readlink $pathname, $callback->($link)
228 aio_realpath $path, $callback->($link) 233 aio_realpath $pathname, $callback->($link)
229 aio_rename $srcpath, $dstpath, $callback->($status) 234 aio_rename $srcpath, $dstpath, $callback->($status)
230 aio_mkdir $pathname, $mode, $callback->($status) 235 aio_mkdir $pathname, $mode, $callback->($status)
231 aio_rmdir $pathname, $callback->($status) 236 aio_rmdir $pathname, $callback->($status)
232 aio_readdir $pathname, $callback->($entries) 237 aio_readdir $pathname, $callback->($entries)
233 aio_readdirx $pathname, $flags, $callback->($entries, $flags) 238 aio_readdirx $pathname, $flags, $callback->($entries, $flags)
234 IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST 239 IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST
235 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)
236 aio_load $path, $data, $callback->($status) 242 aio_load $pathname, $data, $callback->($status)
237 aio_copy $srcpath, $dstpath, $callback->($status) 243 aio_copy $srcpath, $dstpath, $callback->($status)
238 aio_move $srcpath, $dstpath, $callback->($status) 244 aio_move $srcpath, $dstpath, $callback->($status)
239 aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
240 aio_rmtree $path, $callback->($status) 245 aio_rmtree $pathname, $callback->($status)
241 aio_sync $callback->($status) 246 aio_sync $callback->($status)
242 aio_syncfs $fh, $callback->($status) 247 aio_syncfs $fh, $callback->($status)
243 aio_fsync $fh, $callback->($status) 248 aio_fsync $fh, $callback->($status)
244 aio_fdatasync $fh, $callback->($status) 249 aio_fdatasync $fh, $callback->($status)
245 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) 250 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
246 aio_pathsync $path, $callback->($status) 251 aio_pathsync $pathname, $callback->($status)
247 aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 252 aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
248 aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 253 aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
249 aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) 254 aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
250 aio_mlockall $flags, $callback->($status) 255 aio_mlockall $flags, $callback->($status)
251 aio_group $callback->(...) 256 aio_group $callback->(...)
… …
269 IO::AIO::nready 274 IO::AIO::nready
270 IO::AIO::npending 275 IO::AIO::npending
271 276
272 IO::AIO::sendfile $ofh, $ifh, $offset, $count 277 IO::AIO::sendfile $ofh, $ifh, $offset, $count
273 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
274 IO::AIO::madvise $scalar, $offset, $length, $advice 281 IO::AIO::madvise $scalar, $offset, $length, $advice
275 IO::AIO::mprotect $scalar, $offset, $length, $protect 282 IO::AIO::mprotect $scalar, $offset, $length, $protect
276 IO::AIO::munlock $scalar, $offset = 0, $length = undef 283 IO::AIO::munlock $scalar, $offset = 0, $length = undef
277 IO::AIO::munlockall 284 IO::AIO::munlockall
278 285
279=head2 AIO REQUEST FUNCTIONS 286=head2 API NOTES
280 287
281All 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
282with 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,
283and they all accept an additional (and optional) C<$callback> argument 290and they all accept an additional (and optional) C<$callback> argument
284which 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
285the syscall return code (e.g. most syscalls return C<-1> on error, unlike 292the syscall has been executed in an asynchronous fashion. The results
286perl, 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
287syscall 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>.
288 300
289All functions expecting a filehandle keep a copy of the filehandle 301All functions expecting a filehandle keep a copy of the filehandle
290internally until the request has finished. 302internally until the request has finished.
291 303
292All 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
293further manipulation of those requests while they are in-flight. 305further manipulation of those requests while they are in-flight.
294 306
295The pathnames you pass to these routines I<must> be absolute and 307The pathnames you pass to these routines I<should> be absolute. The
296encoded 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
297request is being executed, the current working directory could have 309current working directory could have changed. Alternatively, you can
298changed. Alternatively, you can make sure that you never change the 310make sure that you never change the current working directory anywhere
299current working directory anywhere in the program and then use relative 311in the program and then use relative paths. You can also take advantage
300paths. 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.
301 315
302To 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
303in filenames you got from outside (command line, readdir etc.) without 317in filenames you got from outside (command line, readdir etc.) without
304tinkering, 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
305your pathnames to the locale (or other) encoding in effect in the user 319module and encode your pathnames to the locale (or other) encoding in
306environment, d) use Glib::filename_from_unicode on unicode filenames or e) 320effect in the user environment, d) use Glib::filename_from_unicode on
307use 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.
308 323
309This 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
310handles correctly whether it is set or not. 325handles correctly whether it is set or not.
326
327=head2 AIO REQUEST FUNCTIONS
311 328
312=over 4 329=over 4
313 330
314=item $prev_pri = aioreq_pri [$pri] 331=item $prev_pri = aioreq_pri [$pri]
315 332
… …
345 362
346 363
347=item aio_open $pathname, $flags, $mode, $callback->($fh) 364=item aio_open $pathname, $flags, $mode, $callback->($fh)
348 365
349Asynchronously 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
350created filehandle for the file. 367created filehandle for the file (or C<undef> in case of an error).
351 368
352The 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,
353for an explanation. 370for an explanation.
354 371
355The 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
… …
397 414
398Or 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
399free for reuse until the perl filehandle is closed. 416free for reuse until the perl filehandle is closed.
400 417
401=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".
402 439
403=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 440=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
404 441
405=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 442=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
406 443
… …
566 namemax => 255, 603 namemax => 255,
567 frsize => 1024, 604 frsize => 1024,
568 fsid => 1810 605 fsid => 1810
569 } 606 }
570 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
571 689
572=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 690=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
573 691
574Works 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
575and $mtime being undef). Fractional times are supported if the underlying 693and $mtime being undef). Fractional times are supported if the underlying
… …
603=item aio_truncate $fh_or_path, $offset, $callback->($status) 721=item aio_truncate $fh_or_path, $offset, $callback->($status)
604 722
605Works like truncate(2) or ftruncate(2). 723Works like truncate(2) or ftruncate(2).
606 724
607 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
608=item aio_chmod $fh_or_path, $mode, $callback->($status) 742=item aio_chmod $fh_or_path, $mode, $callback->($status)
609 743
610Works like perl's C<chmod> function. 744Works like perl's C<chmod> function.
611 745
612 746
… …
614 748
615Asynchronously unlink (delete) a file and call the callback with the 749Asynchronously unlink (delete) a file and call the callback with the
616result code. 750result code.
617 751
618 752
619=item aio_mknod $path, $mode, $dev, $callback->($status) 753=item aio_mknod $pathname, $mode, $dev, $callback->($status)
620 754
621[EXPERIMENTAL] 755[EXPERIMENTAL]
622 756
623Asynchronously create a device node (or fifo). See mknod(2). 757Asynchronously create a device node (or fifo). See mknod(2).
624 758
625The only (POSIX-) portable way of calling this function is: 759The only (POSIX-) portable way of calling this function is:
626 760
627 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... 761 aio_mknod $pathname, IO::AIO::S_IFIFO | $mode, 0, sub { ...
628 762
629See C<aio_stat> for info about some potentially helpful extra constants 763See C<aio_stat> for info about some potentially helpful extra constants
630and functions. 764and functions.
631 765
632=item aio_link $srcpath, $dstpath, $callback->($status) 766=item aio_link $srcpath, $dstpath, $callback->($status)
… …
639 773
640Asynchronously 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
641the path C<$dstpath> and call the callback with the result code. 775the path C<$dstpath> and call the callback with the result code.
642 776
643 777
644=item aio_readlink $path, $callback->($link) 778=item aio_readlink $pathname, $callback->($link)
645 779
646Asynchronously read the symlink specified by C<$path> and pass it to 780Asynchronously read the symlink specified by C<$path> and pass it to
647the 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
648callback. 782callback.
649 783
650 784
651=item aio_realpath $path, $callback->($path) 785=item aio_realpath $pathname, $callback->($path)
652 786
653Asynchronously make the path absolute and resolve any symlinks in 787Asynchronously make the path absolute and resolve any symlinks in
654C<$path>. The resulting path only consists of directories (Same as 788C<$path>. The resulting path only consists of directories (same as
655L<Cwd::realpath>). 789L<Cwd::realpath>).
656 790
657This 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
658directory by passing it a path of F<.> (a single dot). 792directory by passing it a path of F<.> (a single dot).
659 793
… …
751C<$type>'s are known, which can be used to speed up some algorithms. 885C<$type>'s are known, which can be used to speed up some algorithms.
752 886
753=back 887=back
754 888
755 889
756=item aio_load $path, $data, $callback->($status) 890=item aio_load $pathname, $data, $callback->($status)
757 891
758This is a composite request that tries to fully load the given file into 892This is a composite request that tries to fully load the given file into
759memory. Status is the same as with aio_read. 893memory. Status is the same as with aio_read.
760 894
761=cut 895=cut
… …
896 }; 1030 };
897 1031
898 $grp 1032 $grp
899} 1033}
900 1034
901=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 1035=item aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
902 1036
903Scans a directory (similar to C<aio_readdir>) but additionally tries to 1037Scans a directory (similar to C<aio_readdir>) but additionally tries to
904efficiently separate the entries of directory C<$path> into two sets of 1038efficiently separate the entries of directory C<$path> into two sets of
905names, directories you can recurse into (directories), and ones you cannot 1039names, directories you can recurse into (directories), and ones you cannot
906recurse into (everything else, including symlinks to directories). 1040recurse into (everything else, including symlinks to directories).
… …
963 1097
964 my $grp = aio_group $cb; 1098 my $grp = aio_group $cb;
965 1099
966 $maxreq = 4 if $maxreq <= 0; 1100 $maxreq = 4 if $maxreq <= 0;
967 1101
968 # stat once 1102 # get a wd object
969 aioreq_pri $pri; 1103 aioreq_pri $pri;
970 add $grp aio_stat $path, sub { 1104 add $grp aio_wd $path, sub {
1105 $_[0]
971 return $grp->result () if $_[0]; 1106 or return $grp->result ();
972 my $now = time;
973 my $hash1 = join ":", (stat _)[0,1,3,7,9];
974 1107
975 # read the directory entries 1108 my $wd = [shift, "."];
1109
1110 # stat once
976 aioreq_pri $pri; 1111 aioreq_pri $pri;
977 add $grp aio_readdirx $path, READDIR_DIRS_FIRST, sub { 1112 add $grp aio_stat $wd, sub {
978 my $entries = shift
979 or return $grp->result (); 1113 return $grp->result () if $_[0];
1114 my $now = time;
1115 my $hash1 = join ":", (stat _)[0,1,3,7,9];
980 1116
981 # stat the dir another time 1117 # read the directory entries
982 aioreq_pri $pri; 1118 aioreq_pri $pri;
1119 add $grp aio_readdirx $wd, READDIR_DIRS_FIRST, sub {
1120 my $entries = shift
1121 or return $grp->result ();
1122
1123 # stat the dir another time
1124 aioreq_pri $pri;
983 add $grp aio_stat $path, sub { 1125 add $grp aio_stat $wd, sub {
984 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 1126 my $hash2 = join ":", (stat _)[0,1,3,7,9];
985 1127
986 my $ndirs; 1128 my $ndirs;
987 1129
988 # take the slow route if anything looks fishy 1130 # take the slow route if anything looks fishy
989 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 1131 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
990 $ndirs = -1; 1132 $ndirs = -1;
991 } else { 1133 } else {
992 # if nlink == 2, we are finished 1134 # if nlink == 2, we are finished
993 # for non-posix-fs's, we rely on nlink < 2 1135 # for non-posix-fs's, we rely on nlink < 2
994 $ndirs = (stat _)[3] - 2 1136 $ndirs = (stat _)[3] - 2
995 or return $grp->result ([], $entries); 1137 or return $grp->result ([], $entries);
996 } 1138 }
997 1139
998 my (@dirs, @nondirs); 1140 my (@dirs, @nondirs);
999 1141
1000 my $statgrp = add $grp aio_group sub { 1142 my $statgrp = add $grp aio_group sub {
1001 $grp->result (\@dirs, \@nondirs); 1143 $grp->result (\@dirs, \@nondirs);
1002 }; 1144 };
1003 1145
1004 limit $statgrp $maxreq; 1146 limit $statgrp $maxreq;
1005 feed $statgrp sub { 1147 feed $statgrp sub {
1006 return unless @$entries; 1148 return unless @$entries;
1007 my $entry = shift @$entries; 1149 my $entry = shift @$entries;
1008 1150
1009 aioreq_pri $pri; 1151 aioreq_pri $pri;
1152 $wd->[1] = "$entry/.";
1010 add $statgrp aio_stat "$path/$entry/.", sub { 1153 add $statgrp aio_stat $wd, sub {
1011 if ($_[0] < 0) { 1154 if ($_[0] < 0) {
1012 push @nondirs, $entry; 1155 push @nondirs, $entry;
1013 } else { 1156 } else {
1014 # need to check for real directory 1157 # need to check for real directory
1015 aioreq_pri $pri; 1158 aioreq_pri $pri;
1159 $wd->[1] = $entry;
1016 add $statgrp aio_lstat "$path/$entry", sub { 1160 add $statgrp aio_lstat $wd, sub {
1017 if (-d _) { 1161 if (-d _) {
1018 push @dirs, $entry; 1162 push @dirs, $entry;
1019 1163
1020 unless (--$ndirs) { 1164 unless (--$ndirs) {
1021 push @nondirs, @$entries; 1165 push @nondirs, @$entries;
1022 feed $statgrp; 1166 feed $statgrp;
1167 }
1168 } else {
1169 push @nondirs, $entry;
1023 } 1170 }
1024 } else {
1025 push @nondirs, $entry;
1026 } 1171 }
1027 } 1172 }
1028 } 1173 };
1029 }; 1174 };
1030 }; 1175 };
1031 }; 1176 };
1032 }; 1177 };
1033 }; 1178 };
1034 1179
1035 $grp 1180 $grp
1036} 1181}
1037 1182
1038=item aio_rmtree $path, $callback->($status) 1183=item aio_rmtree $pathname, $callback->($status)
1039 1184
1040Delete a directory tree starting (and including) C<$path>, return the 1185Delete a directory tree starting (and including) C<$path>, return the
1041status of the final C<rmdir> only. This is a composite request that 1186status of the final C<rmdir> only. This is a composite request that
1042uses C<aio_scandir> to recurse into and rmdir directories, and unlink 1187uses C<aio_scandir> to recurse into and rmdir directories, and unlink
1043everything else. 1188everything else.
1044 1189
1045=cut 1190=cut
1046 1191
… …
1104C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>, 1249C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,
1105C<IO::AIO::SYNC_FILE_RANGE_WRITE> and 1250C<IO::AIO::SYNC_FILE_RANGE_WRITE> and
1106C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range 1251C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range
1107manpage for details. 1252manpage for details.
1108 1253
1109=item aio_pathsync $path, $callback->($status) 1254=item aio_pathsync $pathname, $callback->($status)
1110 1255
1111This request tries to open, fsync and close the given path. This is a 1256This request tries to open, fsync and close the given path. This is a
1112composite request intended to sync directories after directory operations 1257composite request intended to sync directories after directory operations
1113(E.g. rename). This might not work on all operating systems or have any 1258(E.g. rename). This might not work on all operating systems or have any
1114specific effect, but usually it makes sure that directory changes get 1259specific effect, but usually it makes sure that directory changes get
… …
1166 1311
1167This is a rather advanced IO::AIO call, which works best on mmap(2)ed 1312This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1168scalars. 1313scalars.
1169 1314
1170It touches (reads or writes) all memory pages in the specified 1315It touches (reads or writes) all memory pages in the specified
1171range inside the scalar. All caveats and parameters are the same 1316range inside the scalar. All caveats and parameters are the same
1172as for C<aio_msync>, above, except for flags, which must be either 1317as for C<aio_msync>, above, except for flags, which must be either
1173C<0> (which reads all pages and ensures they are instantiated) or 1318C<0> (which reads all pages and ensures they are instantiated) or
1174C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and 1319C<IO::AIO::MT_MODIFY>, which modifies the memory pages (by reading and
1175writing an octet from it, which dirties the page). 1320writing an octet from it, which dirties the page).
1176 1321
1177=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) 1322=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
1178 1323
1179This is a rather advanced IO::AIO call, which works best on mmap(2)ed 1324This is a rather advanced IO::AIO call, which works best on mmap(2)ed
… …
1210documented under L<MISCELLANEOUS FUNCTIONS>. 1355documented under L<MISCELLANEOUS FUNCTIONS>.
1211 1356
1212Example: asynchronously lock all current and future pages into memory. 1357Example: asynchronously lock all current and future pages into memory.
1213 1358
1214 aio_mlockall IO::AIO::MCL_FUTURE; 1359 aio_mlockall IO::AIO::MCL_FUTURE;
1360
1361=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
1362
1363Queries the extents of the given file (by calling the Linux C<FIEMAP>
1364ioctl, see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If
1365the ioctl is not available on your OS, then this request will fail with
1366C<ENOSYS>.
1367
1368C<$start> is the starting offset to query extents for, C<$length> is the
1369size of the range to query - if it is C<undef>, then the whole file will
1370be queried.
1371
1372C<$flags> is a combination of flags (C<IO::AIO::FIEMAP_FLAG_SYNC> or
1373C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also
1374exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query
1375the data portion.
1376
1377C<$count> is the maximum number of extent records to return. If it is
1378C<undef>, then IO::AIO queries all extents of the range. As a very special
1379case, if it is C<0>, then the callback receives the number of extents
1380instead of the extents themselves (which is unreliable, see below).
1381
1382If an error occurs, the callback receives no arguments. The special
1383C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.
1384
1385Otherwise, the callback receives an array reference with extent
1386structures. Each extent structure is an array reference itself, with the
1387following members:
1388
1389 [$logical, $physical, $length, $flags]
1390
1391Flags is any combination of the following flag values (typically either C<0>
1392or C<IO::AIO::FIEMAP_EXTENT_LAST> (1)):
1393
1394C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,
1395C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,
1396C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,
1397C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,
1398C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or
1399C<IO::AIO::FIEMAP_EXTENT_SHARED>.
1400
1401At the time of this writing (Linux 3.2), this requets is unreliable unless
1402C<$count> is C<undef>, as the kernel has all sorts of bugs preventing
1403it to return all extents of a range for files with large number of
1404extents. The code works around all these issues if C<$count> is undef.
1215 1405
1216=item aio_group $callback->(...) 1406=item aio_group $callback->(...)
1217 1407
1218This is a very special aio request: Instead of doing something, it is a 1408This is a very special aio request: Instead of doing something, it is a
1219container for other aio requests, which is useful if you want to bundle 1409container for other aio requests, which is useful if you want to bundle
… …
1256like sleep and file handle readable/writable, the overhead this creates is 1446like sleep and file handle readable/writable, the overhead this creates is
1257immense (it blocks a thread for a long time) so do not use this function 1447immense (it blocks a thread for a long time) so do not use this function
1258except to put your application under artificial I/O pressure. 1448except to put your application under artificial I/O pressure.
1259 1449
1260=back 1450=back
1451
1452
1453=head2 IO::AIO::WD - multiple working directories
1454
1455Your process only has one current working directory, which is used by all
1456threads. This makes it hard to use relative paths (some other component
1457could call C<chdir> at any time, and it is hard to control when the path
1458will be used by IO::AIO).
1459
1460One solution for this is to always use absolute paths. This usually works,
1461but can be quite slow (the kernel has to walk the whole path on every
1462access), and can also be a hassle to implement.
1463
1464Newer POSIX systems have a number of functions (openat, fdopendir,
1465futimensat and so on) that make it possible to specify working directories
1466per operation.
1467
1468For portability, and because the clowns who "designed", or shall I write,
1469perpetrated this new interface were obviously half-drunk, this abstraction
1470cannot be perfect, though.
1471
1472IO::AIO allows you to convert directory paths into a so-called IO::AIO::WD
1473object. This object stores the canonicalised, absolute version of the
1474path, and on systems that allow it, also a directory file descriptor.
1475
1476Everywhere where a pathname is accepted by IO::AIO (e.g. in C<aio_stat>
1477or C<aio_unlink>), one can specify an array reference with an IO::AIO::WD
1478object and a pathname instead (or the IO::AIO::WD object alone, which
1479gets interpreted as C<[$wd, "."]>). If the pathname is absolute, the
1480IO::AIO::WD object is ignored, otherwise the pathname is resolved relative
1481to that IO::AIO::WD object.
1482
1483For example, to get a wd object for F</etc> and then stat F<passwd>
1484inside, you would write:
1485
1486 aio_wd "/etc", sub {
1487 my $etcdir = shift;
1488
1489 # although $etcdir can be undef on error, there is generally no reason
1490 # to check for errors here, as aio_stat will fail with ENOENT
1491 # when $etcdir is undef.
1492
1493 aio_stat [$etcdir, "passwd"], sub {
1494 # yay
1495 };
1496 };
1497
1498That C<aio_wd> is a request and not a normal function shows that creating
1499an IO::AIO::WD object is itself a potentially blocking operation, which is
1500why it is done asynchronously.
1501
1502To stat the directory obtained with C<aio_wd> above, one could write
1503either of the following three request calls:
1504
1505 aio_lstat "/etc" , sub { ... # pathname as normal string
1506 aio_lstat [$wd, "."], sub { ... # "." relative to $wd (i.e. $wd itself)
1507 aio_lstat $wd , sub { ... # shorthand for the previous
1508
1509As with normal pathnames, IO::AIO keeps a copy of the working directory
1510object and the pathname string, so you could write the following without
1511causing any issues due to C<$path> getting reused:
1512
1513 my $path = [$wd, undef];
1514
1515 for my $name (qw(abc def ghi)) {
1516 $path->[1] = $name;
1517 aio_stat $path, sub {
1518 # ...
1519 };
1520 }
1521
1522There are some caveats: when directories get renamed (or deleted), the
1523pathname string doesn't change, so will point to the new directory (or
1524nowhere at all), while the directory fd, if available on the system,
1525will still point to the original directory. Most functions accepting a
1526pathname will use the directory fd on newer systems, and the string on
1527older systems. Some functions (such as realpath) will always rely on the
1528string form of the pathname.
1529
1530So this functionality is mainly useful to get some protection against
1531C<chdir>, to easily get an absolute path out of a relative path for future
1532reference, and to speed up doing many operations in the same directory
1533(e.g. when stat'ing all files in a directory).
1534
1535The following functions implement this working directory abstraction:
1536
1537=over 4
1538
1539=item aio_wd $pathname, $callback->($wd)
1540
1541Asynchonously canonicalise the given pathname and convert it to an
1542IO::AIO::WD object representing it. If possible and supported on the
1543system, also open a directory fd to speed up pathname resolution relative
1544to this working directory.
1545
1546If something goes wrong, then C<undef> is passwd to the callback instead
1547of a working directory object and C<$!> is set appropriately. Since
1548passing C<undef> as working directory component of a pathname fails the
1549request with C<ENOENT>, there is often no need for error checking in the
1550C<aio_wd> callback, as future requests using the value will fail in the
1551expected way.
1552
1553If this call isn't available because your OS lacks it or it couldn't be
1554detected, it will be emulated by calling C<fsync> instead.
1555
1556=item IO::AIO::CWD
1557
1558This is a compiletime constant (object) that represents the process
1559current working directory.
1560
1561Specifying this object as working directory object for a pathname is as if
1562the pathname would be specified directly, without a directory object. For
1563example, these calls are functionally identical:
1564
1565 aio_stat "somefile", sub { ... };
1566 aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
1567
1568=back
1569
1570To recover the path associated with an IO::AIO::WD object, you can use
1571C<aio_realpath>:
1572
1573 aio_realpath $wd, sub {
1574 warn "path is $_[0]\n";
1575 };
1576
1261 1577
1262=head2 IO::AIO::REQ CLASS 1578=head2 IO::AIO::REQ CLASS
1263 1579
1264All non-aggregate C<aio_*> functions return an object of this class when 1580All non-aggregate C<aio_*> functions return an object of this class when
1265called in non-void context. 1581called in non-void context.
… …
1383 1699
1384Sets a feeder/generator on this group: every group can have an attached 1700Sets a feeder/generator on this group: every group can have an attached
1385generator that generates requests if idle. The idea behind this is that, 1701generator that generates requests if idle. The idea behind this is that,
1386although you could just queue as many requests as you want in a group, 1702although you could just queue as many requests as you want in a group,
1387this might starve other requests for a potentially long time. For example, 1703this might starve other requests for a potentially long time. For example,
1388C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests, 1704C<aio_scandir> might generate hundreds of thousands of C<aio_stat>
1389delaying any later requests for a long time. 1705requests, delaying any later requests for a long time.
1390 1706
1391To avoid this, and allow incremental generation of requests, you can 1707To avoid this, and allow incremental generation of requests, you can
1392instead a group and set a feeder on it that generates those requests. The 1708instead a group and set a feeder on it that generates those requests. The
1393feed callback will be called whenever there are few enough (see C<limit>, 1709feed callback will be called whenever there are few enough (see C<limit>,
1394below) requests active in the group itself and is expected to queue more 1710below) requests active in the group itself and is expected to queue more
… …
1703ENOSYS, otherwise the return value of C<mprotect>. 2019ENOSYS, otherwise the return value of C<mprotect>.
1704 2020
1705=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] 2021=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
1706 2022
1707Memory-maps a file (or anonymous memory range) and attaches it to the 2023Memory-maps a file (or anonymous memory range) and attaches it to the
1708given C<$scalar>, which will act like a string scalar. 2024given C<$scalar>, which will act like a string scalar. Returns true on
2025success, and false otherwise.
1709 2026
1710The only operations allowed on the scalar are C<substr>/C<vec> that don't 2027The only operations allowed on the scalar are C<substr>/C<vec> that don't
1711change the string length, and most read-only operations such as copying it 2028change the string length, and most read-only operations such as copying it
1712or searching it with regexes and so on. 2029or searching it with regexes and so on.
1713 2030
… …
1766Calls the C<munlockall> function. 2083Calls the C<munlockall> function.
1767 2084
1768On systems that do not implement C<munlockall>, this function returns 2085On systems that do not implement C<munlockall>, this function returns
1769ENOSYS, otherwise the return value of C<munlockall>. 2086ENOSYS, otherwise the return value of C<munlockall>.
1770 2087
2088=item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
2089
2090Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or
2091C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they
2092should be the file offset.
2093
2094C<$r_fh> and C<$w_fh> should not refer to the same file, as splice might
2095silently corrupt the data in this case.
2096
2097The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>,
2098C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and
2099C<IO::AIO::SPLICE_F_GIFT>.
2100
2101See the C<splice(2)> manpage for details.
2102
2103=item IO::AIO::tee $r_fh, $w_fh, $length, $flags
2104
2105Calls the GNU/Linux C<tee(2)> syscall, see it's manpage and the
2106description for C<IO::AIO::splice> above for details.
2107
1771=back 2108=back
1772 2109
1773=cut 2110=cut
1774 2111
1775min_parallel 8; 2112min_parallel 8;

Diff Legend

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