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.147 by root, Wed Jun 3 12:24:49 2009 UTC vs.
Revision 1.182 by root, Sun Sep 12 03:36:27 2010 UTC

… …
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 use IO::AIO; 7 use IO::AIO;
8 8
9 aio_open "/etc/passwd", O_RDONLY, 0, sub { 9 aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
10 my $fh = shift 10 my $fh = shift
11 or die "/etc/passwd: $!"; 11 or die "/etc/passwd: $!";
12 ... 12 ...
13 }; 13 };
14 14
… …
26 $req->cancel; # cancel request if still in queue 26 $req->cancel; # cancel request if still in queue
27 27
28 my $grp = aio_group sub { print "all stats done\n" }; 28 my $grp = aio_group sub { print "all stats done\n" };
29 add $grp aio_stat "..." for ...; 29 add $grp aio_stat "..." for ...;
30 30
31 # AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
32 use AnyEvent::AIO;
33
34 # EV integration
35 my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
36
37 # Event integration
38 Event->io (fd => IO::AIO::poll_fileno,
39 poll => 'r',
40 cb => \&IO::AIO::poll_cb);
41
42 # Glib/Gtk2 integration
43 add_watch Glib::IO IO::AIO::poll_fileno,
44 in => sub { IO::AIO::poll_cb; 1 };
45
46 # Tk integration
47 Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
48 readable => \&IO::AIO::poll_cb);
49
50 # Danga::Socket integration
51 Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
52 \&IO::AIO::poll_cb);
53
54=head1 DESCRIPTION 31=head1 DESCRIPTION
55 32
56This module implements asynchronous I/O using whatever means your 33This module implements asynchronous I/O using whatever means your
57operating system supports. 34operating system supports. It is implemented as an interface to C<libeio>
35(L<http://software.schmorp.de/pkg/libeio.html>).
58 36
59Asynchronous means that operations that can normally block your program 37Asynchronous means that operations that can normally block your program
60(e.g. reading from disk) will be done asynchronously: the operation 38(e.g. reading from disk) will be done asynchronously: the operation
61will still block, but you can do something else in the meantime. This 39will still block, but you can do something else in the meantime. This
62is extremely useful for programs that need to stay interactive even 40is extremely useful for programs that need to stay interactive even
… …
66on a RAID volume or over NFS when you do a number of stat operations 44on a RAID volume or over NFS when you do a number of stat operations
67concurrently. 45concurrently.
68 46
69While most of this works on all types of file descriptors (for 47While most of this works on all types of file descriptors (for
70example sockets), using these functions on file descriptors that 48example sockets), using these functions on file descriptors that
71support nonblocking operation (again, sockets, pipes etc.) is very 49support nonblocking operation (again, sockets, pipes etc.) is
72inefficient. Use an event loop for that (such as the L<Event|Event> 50very inefficient. Use an event loop for that (such as the L<EV>
73module): IO::AIO will naturally fit into such an event loop itself. 51module): IO::AIO will naturally fit into such an event loop itself.
74 52
75In this version, a number of threads are started that execute your 53In this version, a number of threads are started that execute your
76requests and signal their completion. You don't need thread support 54requests and signal their completion. You don't need thread support
77in perl, and the threads created by this module will not be visible 55in perl, and the threads created by this module will not be visible
… …
87yourself, always call C<poll_cb> from within the same thread, or never 65yourself, always call C<poll_cb> from within the same thread, or never
88call C<poll_cb> (or other C<aio_> functions) recursively. 66call C<poll_cb> (or other C<aio_> functions) recursively.
89 67
90=head2 EXAMPLE 68=head2 EXAMPLE
91 69
92This is a simple example that uses the Event module and loads 70This is a simple example that uses the EV module and loads
93F</etc/passwd> asynchronously: 71F</etc/passwd> asynchronously:
94 72
95 use Fcntl; 73 use Fcntl;
96 use Event; 74 use EV;
97 use IO::AIO; 75 use IO::AIO;
98 76
99 # register the IO::AIO callback with Event 77 # register the IO::AIO callback with EV
100 Event->io (fd => IO::AIO::poll_fileno, 78 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
101 poll => 'r',
102 cb => \&IO::AIO::poll_cb);
103 79
104 # queue the request to open /etc/passwd 80 # queue the request to open /etc/passwd
105 aio_open "/etc/passwd", O_RDONLY, 0, sub { 81 aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
106 my $fh = shift 82 my $fh = shift
107 or die "error while opening: $!"; 83 or die "error while opening: $!";
108 84
109 # stat'ing filehandles is generally non-blocking 85 # stat'ing filehandles is generally non-blocking
110 my $size = -s $fh; 86 my $size = -s $fh;
… …
119 95
120 # file contents now in $contents 96 # file contents now in $contents
121 print $contents; 97 print $contents;
122 98
123 # exit event loop and program 99 # exit event loop and program
124 Event::unloop; 100 EV::unloop;
125 }; 101 };
126 }; 102 };
127 103
128 # possibly queue up other requests, or open GUI windows, 104 # possibly queue up other requests, or open GUI windows,
129 # check for sockets etc. etc. 105 # check for sockets etc. etc.
130 106
131 # process events as long as there are some: 107 # process events as long as there are some:
132 Event::loop; 108 EV::loop;
133 109
134=head1 REQUEST ANATOMY AND LIFETIME 110=head1 REQUEST ANATOMY AND LIFETIME
135 111
136Every C<aio_*> function creates a request. which is a C data structure not 112Every C<aio_*> function creates a request. which is a C data structure not
137directly visible to Perl. 113directly visible to Perl.
… …
187 163
188package IO::AIO; 164package IO::AIO;
189 165
190use Carp (); 166use Carp ();
191 167
192no warnings; 168use common::sense;
193use strict 'vars';
194 169
195use base 'Exporter'; 170use base 'Exporter';
196 171
197BEGIN { 172BEGIN {
198 our $VERSION = '3.19'; 173 our $VERSION = '3.65';
199 174
200 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close 175 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close
201 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir 176 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx
202 aio_scandir aio_symlink aio_readlink aio_sync aio_fsync 177 aio_scandir aio_symlink aio_readlink aio_sync aio_fsync
203 aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead 178 aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead
204 aio_rename aio_link aio_move aio_copy aio_group 179 aio_rename aio_link aio_move aio_copy aio_group
205 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown 180 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
206 aio_chmod aio_utime aio_truncate); 181 aio_chmod aio_utime aio_truncate
182 aio_msync aio_mtouch aio_mlock aio_mlockall
183 aio_statvfs);
207 184
208 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); 185 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
209 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 186 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
210 min_parallel max_parallel max_idle 187 min_parallel max_parallel max_idle
211 nreqs nready npending nthreads 188 nreqs nready npending nthreads
212 max_poll_time max_poll_reqs); 189 max_poll_time max_poll_reqs
190 sendfile fadvise madvise
191 mmap munmap munlock munlockall);
213 192
214 push @AIO_REQ, qw(aio_busy); # not exported 193 push @AIO_REQ, qw(aio_busy); # not exported
215 194
216 @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; 195 @IO::AIO::GRP::ISA = 'IO::AIO::REQ';
217 196
218 require XSLoader; 197 require XSLoader;
219 XSLoader::load ("IO::AIO", $VERSION); 198 XSLoader::load ("IO::AIO", $VERSION);
220} 199}
221 200
222=head1 FUNCTIONS 201=head1 FUNCTIONS
202
203=head2 QUICK OVERVIEW
204
205This section simply lists the prototypes of the most important functions
206for quick reference. See the following sections for function-by-function
207documentation.
208
209 aio_open $pathname, $flags, $mode, $callback->($fh)
210 aio_close $fh, $callback->($status)
211 aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
212 aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
213 aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
214 aio_readahead $fh,$offset,$length, $callback->($retval)
215 aio_stat $fh_or_path, $callback->($status)
216 aio_lstat $fh, $callback->($status)
217 aio_statvfs $fh_or_path, $callback->($statvfs)
218 aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
219 aio_chown $fh_or_path, $uid, $gid, $callback->($status)
220 aio_truncate $fh_or_path, $offset, $callback->($status)
221 aio_chmod $fh_or_path, $mode, $callback->($status)
222 aio_unlink $pathname, $callback->($status)
223 aio_mknod $path, $mode, $dev, $callback->($status)
224 aio_link $srcpath, $dstpath, $callback->($status)
225 aio_symlink $srcpath, $dstpath, $callback->($status)
226 aio_readlink $path, $callback->($link)
227 aio_rename $srcpath, $dstpath, $callback->($status)
228 aio_mkdir $pathname, $mode, $callback->($status)
229 aio_rmdir $pathname, $callback->($status)
230 aio_readdir $pathname, $callback->($entries)
231 aio_readdirx $pathname, $flags, $callback->($entries, $flags)
232 IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST
233 IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN
234 aio_load $path, $data, $callback->($status)
235 aio_copy $srcpath, $dstpath, $callback->($status)
236 aio_move $srcpath, $dstpath, $callback->($status)
237 aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
238 aio_rmtree $path, $callback->($status)
239 aio_sync $callback->($status)
240 aio_fsync $fh, $callback->($status)
241 aio_fdatasync $fh, $callback->($status)
242 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
243 aio_pathsync $path, $callback->($status)
244 aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
245 aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
246 aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
247 aio_mlockall $flags, $callback->($status)
248 aio_group $callback->(...)
249 aio_nop $callback->()
250
251 $prev_pri = aioreq_pri [$pri]
252 aioreq_nice $pri_adjust
253
254 IO::AIO::poll_wait
255 IO::AIO::poll_cb
256 IO::AIO::poll
257 IO::AIO::flush
258 IO::AIO::max_poll_reqs $nreqs
259 IO::AIO::max_poll_time $seconds
260 IO::AIO::min_parallel $nthreads
261 IO::AIO::max_parallel $nthreads
262 IO::AIO::max_idle $nthreads
263 IO::AIO::max_outstanding $maxreqs
264 IO::AIO::nreqs
265 IO::AIO::nready
266 IO::AIO::npending
267
268 IO::AIO::sendfile $ofh, $ifh, $offset, $count
269 IO::AIO::fadvise $fh, $offset, $len, $advice
270 IO::AIO::munlock $scalar, $offset = 0, $length = undef
271 IO::AIO::munlockall
223 272
224=head2 AIO REQUEST FUNCTIONS 273=head2 AIO REQUEST FUNCTIONS
225 274
226All the C<aio_*> calls are more or less thin wrappers around the syscall 275All the C<aio_*> calls are more or less thin wrappers around the syscall
227with the same name (sans C<aio_>). The arguments are similar or identical, 276with the same name (sans C<aio_>). The arguments are similar or identical,
… …
307by the umask in effect then the request is being executed, so better never 356by the umask in effect then the request is being executed, so better never
308change the umask. 357change the umask.
309 358
310Example: 359Example:
311 360
312 aio_open "/etc/passwd", O_RDONLY, 0, sub { 361 aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
313 if ($_[0]) { 362 if ($_[0]) {
314 print "open successful, fh is $_[0]\n"; 363 print "open successful, fh is $_[0]\n";
315 ... 364 ...
316 } else { 365 } else {
317 die "open failed: $!\n"; 366 die "open failed: $!\n";
… …
379than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each 428than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each
380other. 429other.
381 430
382This call tries to make use of a native C<sendfile> syscall to provide 431This call tries to make use of a native C<sendfile> syscall to provide
383zero-copy operation. For this to work, C<$out_fh> should refer to a 432zero-copy operation. For this to work, C<$out_fh> should refer to a
384socket, and C<$in_fh> should refer to mmap'able file. 433socket, and C<$in_fh> should refer to an mmap'able file.
385 434
386If the native sendfile call fails or is not implemented, it will be 435If a native sendfile cannot be found or it fails with C<ENOSYS>,
436C<ENOTSUP>, C<EOPNOTSUPP>, C<EAFNOSUPPORT>, C<EPROTOTYPE> or C<ENOTSOCK>,
387emulated, so you can call C<aio_sendfile> on any type of filehandle 437it will be emulated, so you can call C<aio_sendfile> on any type of
388regardless of the limitations of the operating system. 438filehandle regardless of the limitations of the operating system.
389 439
390Please note, however, that C<aio_sendfile> can read more bytes from 440Please note, however, that C<aio_sendfile> can read more bytes from
391C<$in_fh> than are written, and there is no way to find out how many 441C<$in_fh> than are written, and there is no way to find out how many
392bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only 442bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only
393provides the number of bytes written to C<$out_fh>. Only if the result 443provides the number of bytes written to C<$out_fh>. Only if the result
… …
431 $_[0] and die "stat failed: $!"; 481 $_[0] and die "stat failed: $!";
432 print "size is ", -s _, "\n"; 482 print "size is ", -s _, "\n";
433 }; 483 };
434 484
435 485
486=item aio_statvfs $fh_or_path, $callback->($statvfs)
487
488Works like the POSIX C<statvfs> or C<fstatvfs> syscalls, depending on
489whether a file handle or path was passed.
490
491On success, the callback is passed a hash reference with the following
492members: C<bsize>, C<frsize>, C<blocks>, C<bfree>, C<bavail>, C<files>,
493C<ffree>, C<favail>, C<fsid>, C<flag> and C<namemax>. On failure, C<undef>
494is passed.
495
496The following POSIX IO::AIO::ST_* constants are defined: C<ST_RDONLY> and
497C<ST_NOSUID>.
498
499The following non-POSIX IO::AIO::ST_* flag masks are defined to
500their correct value when available, or to C<0> on systems that do
501not support them: C<ST_NODEV>, C<ST_NOEXEC>, C<ST_SYNCHRONOUS>,
502C<ST_MANDLOCK>, C<ST_WRITE>, C<ST_APPEND>, C<ST_IMMUTABLE>, C<ST_NOATIME>,
503C<ST_NODIRATIME> and C<ST_RELATIME>.
504
505Example: stat C</wd> and dump out the data if successful.
506
507 aio_statvfs "/wd", sub {
508 my $f = $_[0]
509 or die "statvfs: $!";
510
511 use Data::Dumper;
512 say Dumper $f;
513 };
514
515 # result:
516 {
517 bsize => 1024,
518 bfree => 4333064312,
519 blocks => 10253828096,
520 files => 2050765568,
521 flag => 4096,
522 favail => 2042092649,
523 bavail => 4333064312,
524 ffree => 2042092649,
525 namemax => 255,
526 frsize => 1024,
527 fsid => 1810
528 }
529
530
436=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 531=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
437 532
438Works like perl's C<utime> function (including the special case of $atime 533Works like perl's C<utime> function (including the special case of $atime
439and $mtime being undef). Fractional times are supported if the underlying 534and $mtime being undef). Fractional times are supported if the underlying
440syscalls support them. 535syscalls support them.
… …
533 628
534Unlike the POSIX call of the same name, C<aio_readdir> reads an entire 629Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
535directory (i.e. opendir + readdir + closedir). The entries will not be 630directory (i.e. opendir + readdir + closedir). The entries will not be
536sorted, and will B<NOT> include the C<.> and C<..> entries. 631sorted, and will B<NOT> include the C<.> and C<..> entries.
537 632
538The callback a single argument which is either C<undef> or an array-ref 633The callback is passed a single argument which is either C<undef> or an
539with the filenames. 634array-ref with the filenames.
635
636
637=item aio_readdirx $pathname, $flags, $callback->($entries, $flags)
638
639Quite similar to C<aio_readdir>, but the C<$flags> argument allows to tune
640behaviour and output format. In case of an error, C<$entries> will be
641C<undef>.
642
643The flags are a combination of the following constants, ORed together (the
644flags will also be passed to the callback, possibly modified):
645
646=over 4
647
648=item IO::AIO::READDIR_DENTS
649
650When this flag is off, then the callback gets an arrayref with of names
651only (as with C<aio_readdir>), otherwise it gets an arrayref with
652C<[$name, $type, $inode]> arrayrefs, each describing a single directory
653entry in more detail.
654
655C<$name> is the name of the entry.
656
657C<$type> is one of the C<IO::AIO::DT_xxx> constants:
658
659C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>,
660C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>,
661C<IO::AIO::DT_WHT>.
662
663C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to
664know, you have to run stat yourself. Also, for speed reasons, the C<$type>
665scalars are read-only: you can not modify them.
666
667C<$inode> is the inode number (which might not be exact on systems with 64
668bit inode numbers and 32 bit perls). This field has unspecified content on
669systems that do not deliver the inode information.
670
671=item IO::AIO::READDIR_DIRS_FIRST
672
673When this flag is set, then the names will be returned in an order where
674likely directories come first. This is useful when you need to quickly
675find directories, or you want to find all directories while avoiding to
676stat() each entry.
677
678If the system returns type information in readdir, then this is used
679to find directories directly. Otherwise, likely directories are files
680beginning with ".", or otherwise files with no dots, of which files with
681short names are tried first.
682
683=item IO::AIO::READDIR_STAT_ORDER
684
685When this flag is set, then the names will be returned in an order
686suitable for stat()'ing each one. That is, when you plan to stat()
687all files in the given directory, then the returned order will likely
688be fastest.
689
690If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, then
691the likely dirs come first, resulting in a less optimal stat order.
692
693=item IO::AIO::READDIR_FOUND_UNKNOWN
694
695This flag should not be set when calling C<aio_readdirx>. Instead, it
696is being set by C<aio_readdirx>, when any of the C<$type>'s found were
697C<IO::AIO::DT_UNKNOWN>. The absense of this flag therefore indicates that all
698C<$type>'s are known, which can be used to speed up some algorithms.
699
700=back
540 701
541 702
542=item aio_load $path, $data, $callback->($status) 703=item aio_load $path, $data, $callback->($status)
543 704
544This is a composite request that tries to fully load the given file into 705This is a composite request that tries to fully load the given file into
… …
569 730
570=item aio_copy $srcpath, $dstpath, $callback->($status) 731=item aio_copy $srcpath, $dstpath, $callback->($status)
571 732
572Try to copy the I<file> (directories not supported as either source or 733Try to copy the I<file> (directories not supported as either source or
573destination) from C<$srcpath> to C<$dstpath> and call the callback with 734destination) from C<$srcpath> to C<$dstpath> and call the callback with
574the C<0> (error) or C<-1> ok. 735a status of C<0> (ok) or C<-1> (error, see C<$!>).
575 736
576This is a composite request that creates the destination file with 737This is a composite request that creates the destination file with
577mode 0200 and copies the contents of the source file into it using 738mode 0200 and copies the contents of the source file into it using
578C<aio_sendfile>, followed by restoring atime, mtime, access mode and 739C<aio_sendfile>, followed by restoring atime, mtime, access mode and
579uid/gid, in that order. 740uid/gid, in that order.
… …
591 my $grp = aio_group $cb; 752 my $grp = aio_group $cb;
592 753
593 aioreq_pri $pri; 754 aioreq_pri $pri;
594 add $grp aio_open $src, O_RDONLY, 0, sub { 755 add $grp aio_open $src, O_RDONLY, 0, sub {
595 if (my $src_fh = $_[0]) { 756 if (my $src_fh = $_[0]) {
596 my @stat = stat $src_fh; # hmm, might bock over nfs? 757 my @stat = stat $src_fh; # hmm, might block over nfs?
597 758
598 aioreq_pri $pri; 759 aioreq_pri $pri;
599 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { 760 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
600 if (my $dst_fh = $_[0]) { 761 if (my $dst_fh = $_[0]) {
601 aioreq_pri $pri; 762 aioreq_pri $pri;
… …
648 809
649=item aio_move $srcpath, $dstpath, $callback->($status) 810=item aio_move $srcpath, $dstpath, $callback->($status)
650 811
651Try to move the I<file> (directories not supported as either source or 812Try to move the I<file> (directories not supported as either source or
652destination) from C<$srcpath> to C<$dstpath> and call the callback with 813destination) from C<$srcpath> to C<$dstpath> and call the callback with
653the C<0> (error) or C<-1> ok. 814a status of C<0> (ok) or C<-1> (error, see C<$!>).
654 815
655This is a composite request that tries to rename(2) the file first; if 816This is a composite request that tries to rename(2) the file first; if
656rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if 817rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if
657that is successful, unlinks the C<$srcpath>. 818that is successful, unlinks the C<$srcpath>.
658 819
… …
709 870
710Implementation notes. 871Implementation notes.
711 872
712The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can. 873The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can.
713 874
875If readdir returns file type information, then this is used directly to
876find directories.
877
714After reading the directory, the modification time, size etc. of the 878Otherwise, after reading the directory, the modification time, size etc.
715directory before and after the readdir is checked, and if they match (and 879of the directory before and after the readdir is checked, and if they
716isn't the current time), the link count will be used to decide how many 880match (and isn't the current time), the link count will be used to decide
717entries are directories (if >= 2). Otherwise, no knowledge of the number 881how many entries are directories (if >= 2). Otherwise, no knowledge of the
718of subdirectories will be assumed. 882number of subdirectories will be assumed.
719 883
720Then entries will be sorted into likely directories (everything without 884Then entries will be sorted into likely directories a non-initial dot
721a non-initial dot currently) and likely non-directories (everything 885currently) and likely non-directories (see C<aio_readdirx>). Then every
722else). Then every entry plus an appended C</.> will be C<stat>'ed, 886entry plus an appended C</.> will be C<stat>'ed, likely directories first,
723likely directories first. If that succeeds, it assumes that the entry 887in order of their inode numbers. If that succeeds, it assumes that the
724is a directory or a symlink to directory (which will be checked 888entry is a directory or a symlink to directory (which will be checked
725seperately). This is often faster than stat'ing the entry itself because 889seperately). This is often faster than stat'ing the entry itself because
726filesystems might detect the type of the entry without reading the inode 890filesystems might detect the type of the entry without reading the inode
727data (e.g. ext2fs filetype feature). 891data (e.g. ext2fs filetype feature), even on systems that cannot return
892the filetype information on readdir.
728 893
729If the known number of directories (link count - 2) has been reached, the 894If the known number of directories (link count - 2) has been reached, the
730rest of the entries is assumed to be non-directories. 895rest of the entries is assumed to be non-directories.
731 896
732This only works with certainty on POSIX (= UNIX) filesystems, which 897This only works with certainty on POSIX (= UNIX) filesystems, which
… …
754 my $now = time; 919 my $now = time;
755 my $hash1 = join ":", (stat _)[0,1,3,7,9]; 920 my $hash1 = join ":", (stat _)[0,1,3,7,9];
756 921
757 # read the directory entries 922 # read the directory entries
758 aioreq_pri $pri; 923 aioreq_pri $pri;
759 add $grp aio_readdir $path, sub { 924 add $grp aio_readdirx $path, READDIR_DIRS_FIRST, sub {
760 my $entries = shift 925 my $entries = shift
761 or return $grp->result (); 926 or return $grp->result ();
762 927
763 # stat the dir another time 928 # stat the dir another time
764 aioreq_pri $pri; 929 aioreq_pri $pri;
… …
770 # take the slow route if anything looks fishy 935 # take the slow route if anything looks fishy
771 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 936 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
772 $ndirs = -1; 937 $ndirs = -1;
773 } else { 938 } else {
774 # if nlink == 2, we are finished 939 # if nlink == 2, we are finished
775 # on non-posix-fs's, we rely on nlink < 2 940 # for non-posix-fs's, we rely on nlink < 2
776 $ndirs = (stat _)[3] - 2 941 $ndirs = (stat _)[3] - 2
777 or return $grp->result ([], $entries); 942 or return $grp->result ([], $entries);
778 } 943 }
779 944
780 # sort into likely dirs and likely nondirs
781 # dirs == files without ".", short entries first
782 $entries = [map $_->[0],
783 sort { $b->[1] cmp $a->[1] }
784 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
785 @$entries];
786
787 my (@dirs, @nondirs); 945 my (@dirs, @nondirs);
788 946
789 my $statgrp = add $grp aio_group sub { 947 my $statgrp = add $grp aio_group sub {
790 $grp->result (\@dirs, \@nondirs); 948 $grp->result (\@dirs, \@nondirs);
791 }; 949 };
792 950
793 limit $statgrp $maxreq; 951 limit $statgrp $maxreq;
794 feed $statgrp sub { 952 feed $statgrp sub {
795 return unless @$entries; 953 return unless @$entries;
796 my $entry = pop @$entries; 954 my $entry = shift @$entries;
797 955
798 aioreq_pri $pri; 956 aioreq_pri $pri;
799 add $statgrp aio_stat "$path/$entry/.", sub { 957 add $statgrp aio_stat "$path/$entry/.", sub {
800 if ($_[0] < 0) { 958 if ($_[0] < 0) {
801 push @nondirs, $entry; 959 push @nondirs, $entry;
… …
895(E.g. rename). This might not work on all operating systems or have any 1053(E.g. rename). This might not work on all operating systems or have any
896specific effect, but usually it makes sure that directory changes get 1054specific effect, but usually it makes sure that directory changes get
897written to disc. It works for anything that can be opened for read-only, 1055written to disc. It works for anything that can be opened for read-only,
898not just directories. 1056not just directories.
899 1057
1058Future versions of this function might fall back to other methods when
1059C<fsync> on the directory fails (such as calling C<sync>).
1060
900Passes C<0> when everything went ok, and C<-1> on error. 1061Passes C<0> when everything went ok, and C<-1> on error.
901 1062
902=cut 1063=cut
903 1064
904sub aio_pathsync($;$) { 1065sub aio_pathsync($;$) {
… …
924 }; 1085 };
925 1086
926 $grp 1087 $grp
927} 1088}
928 1089
1090=item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
1091
1092This is a rather advanced IO::AIO call, which only works on mmap(2)ed
1093scalars (see the C<IO::AIO::mmap> function, although it also works on data
1094scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the
1095scalar must only be modified in-place while an aio operation is pending on
1096it).
1097
1098It calls the C<msync> function of your OS, if available, with the memory
1099area starting at C<$offset> in the string and ending C<$length> bytes
1100later. If C<$length> is negative, counts from the end, and if C<$length>
1101is C<undef>, then it goes till the end of the string. The flags can be
1102a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and
1103C<IO::AIO::MS_SYNC>.
1104
1105=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
1106
1107This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1108scalars.
1109
1110It touches (reads or writes) all memory pages in the specified
1111range inside the scalar. All caveats and parameters are the same
1112as for C<aio_msync>, above, except for flags, which must be either
1113C<0> (which reads all pages and ensures they are instantiated) or
1114C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and
1115writing an octet from it, which dirties the page).
1116
1117=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
1118
1119This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1120scalars.
1121
1122It reads in all the pages of the underlying storage into memory (if any)
1123and locks them, so they are not getting swapped/paged out or removed.
1124
1125If C<$length> is undefined, then the scalar will be locked till the end.
1126
1127On systems that do not implement C<mlock>, this function returns C<-1>
1128and sets errno to C<ENOSYS>.
1129
1130Note that the corresponding C<munlock> is synchronous and is
1131documented under L<MISCELLANEOUS FUNCTIONS>.
1132
1133=item aio_mlockall $flags, $callback->($status)
1134
1135Calls the C<mlockall> function with the given C<$flags> (a combination of
1136C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>).
1137
1138On systems that do not implement C<mlockall>, this function returns C<-1>
1139and sets errno to C<ENOSYS>.
1140
1141Note that the corresponding C<munlockall> is synchronous and is
1142documented under L<MISCELLANEOUS FUNCTIONS>.
1143
929=item aio_group $callback->(...) 1144=item aio_group $callback->(...)
930 1145
931This is a very special aio request: Instead of doing something, it is a 1146This is a very special aio request: Instead of doing something, it is a
932container for other aio requests, which is useful if you want to bundle 1147container for other aio requests, which is useful if you want to bundle
933many requests into a single, composite, request with a definite callback 1148many requests into a single, composite, request with a definite callback
… …
982=item cancel $req 1197=item cancel $req
983 1198
984Cancels the request, if possible. Has the effect of skipping execution 1199Cancels the request, if possible. Has the effect of skipping execution
985when entering the B<execute> state and skipping calling the callback when 1200when entering the B<execute> state and skipping calling the callback when
986entering the the B<result> state, but will leave the request otherwise 1201entering the the B<result> state, but will leave the request otherwise
987untouched. That means that requests that currently execute will not be 1202untouched (with the exception of readdir). That means that requests that
988stopped and resources held by the request will not be freed prematurely. 1203currently execute will not be stopped and resources held by the request
1204will not be freed prematurely.
989 1205
990=item cb $req $callback->(...) 1206=item cb $req $callback->(...)
991 1207
992Replace (or simply set) the callback registered to the request. 1208Replace (or simply set) the callback registered to the request.
993 1209
… …
1066 1282
1067=item $grp->cancel_subs 1283=item $grp->cancel_subs
1068 1284
1069Cancel all subrequests and clears any feeder, but not the group request 1285Cancel all subrequests and clears any feeder, but not the group request
1070itself. Useful when you queued a lot of events but got a result early. 1286itself. Useful when you queued a lot of events but got a result early.
1287
1288The group request will finish normally (you cannot add requests to the
1289group).
1071 1290
1072=item $grp->result (...) 1291=item $grp->result (...)
1073 1292
1074Set the result value(s) that will be passed to the group callback when all 1293Set the result value(s) that will be passed to the group callback when all
1075subrequests have finished and set the groups errno to the current value 1294subrequests have finished and set the groups errno to the current value
… …
1144=over 4 1363=over 4
1145 1364
1146=item $fileno = IO::AIO::poll_fileno 1365=item $fileno = IO::AIO::poll_fileno
1147 1366
1148Return the I<request result pipe file descriptor>. This filehandle must be 1367Return the I<request result pipe file descriptor>. This filehandle must be
1149polled for reading by some mechanism outside this module (e.g. Event or 1368polled for reading by some mechanism outside this module (e.g. EV, Glib,
1150select, see below or the SYNOPSIS). If the pipe becomes readable you have 1369select and so on, see below or the SYNOPSIS). If the pipe becomes readable
1151to call C<poll_cb> to check the results. 1370you have to call C<poll_cb> to check the results.
1152 1371
1153See C<poll_cb> for an example. 1372See C<poll_cb> for an example.
1154 1373
1155=item IO::AIO::poll_cb 1374=item IO::AIO::poll_cb
1156 1375
… …
1163If not all requests were processed for whatever reason, the filehandle 1382If not all requests were processed for whatever reason, the filehandle
1164will still be ready when C<poll_cb> returns, so normally you don't have to 1383will still be ready when C<poll_cb> returns, so normally you don't have to
1165do anything special to have it called later. 1384do anything special to have it called later.
1166 1385
1167Example: Install an Event watcher that automatically calls 1386Example: Install an Event watcher that automatically calls
1168IO::AIO::poll_cb with high priority: 1387IO::AIO::poll_cb with high priority (more examples can be found in the
1388SYNOPSIS section, at the top of this document):
1169 1389
1170 Event->io (fd => IO::AIO::poll_fileno, 1390 Event->io (fd => IO::AIO::poll_fileno,
1171 poll => 'r', async => 1, 1391 poll => 'r', async => 1,
1172 cb => \&IO::AIO::poll_cb); 1392 cb => \&IO::AIO::poll_cb);
1393
1394=item IO::AIO::poll_wait
1395
1396If there are any outstanding requests and none of them in the result
1397phase, wait till the result filehandle becomes ready for reading (simply
1398does a C<select> on the filehandle. This is useful if you want to
1399synchronously wait for some requests to finish).
1400
1401See C<nreqs> for an example.
1402
1403=item IO::AIO::poll
1404
1405Waits until some requests have been handled.
1406
1407Returns the number of requests processed, but is otherwise strictly
1408equivalent to:
1409
1410 IO::AIO::poll_wait, IO::AIO::poll_cb
1411
1412=item IO::AIO::flush
1413
1414Wait till all outstanding AIO requests have been handled.
1415
1416Strictly equivalent to:
1417
1418 IO::AIO::poll_wait, IO::AIO::poll_cb
1419 while IO::AIO::nreqs;
1173 1420
1174=item IO::AIO::max_poll_reqs $nreqs 1421=item IO::AIO::max_poll_reqs $nreqs
1175 1422
1176=item IO::AIO::max_poll_time $seconds 1423=item IO::AIO::max_poll_time $seconds
1177 1424
… …
1202 # use a low priority so other tasks have priority 1449 # use a low priority so other tasks have priority
1203 Event->io (fd => IO::AIO::poll_fileno, 1450 Event->io (fd => IO::AIO::poll_fileno,
1204 poll => 'r', nice => 1, 1451 poll => 'r', nice => 1,
1205 cb => &IO::AIO::poll_cb); 1452 cb => &IO::AIO::poll_cb);
1206 1453
1207=item IO::AIO::poll_wait
1208
1209If there are any outstanding requests and none of them in the result
1210phase, wait till the result filehandle becomes ready for reading (simply
1211does a C<select> on the filehandle. This is useful if you want to
1212synchronously wait for some requests to finish).
1213
1214See C<nreqs> for an example.
1215
1216=item IO::AIO::poll
1217
1218Waits until some requests have been handled.
1219
1220Returns the number of requests processed, but is otherwise strictly
1221equivalent to:
1222
1223 IO::AIO::poll_wait, IO::AIO::poll_cb
1224
1225=item IO::AIO::flush
1226
1227Wait till all outstanding AIO requests have been handled.
1228
1229Strictly equivalent to:
1230
1231 IO::AIO::poll_wait, IO::AIO::poll_cb
1232 while IO::AIO::nreqs;
1233
1234=back 1454=back
1235 1455
1236=head3 CONTROLLING THE NUMBER OF THREADS 1456=head3 CONTROLLING THE NUMBER OF THREADS
1237 1457
1238=over 1458=over
… …
1330Returns the number of requests currently in the pending state (executed, 1550Returns the number of requests currently in the pending state (executed,
1331but not yet processed by poll_cb). 1551but not yet processed by poll_cb).
1332 1552
1333=back 1553=back
1334 1554
1555=head3 MISCELLANEOUS FUNCTIONS
1556
1557IO::AIO implements some functions that might be useful, but are not
1558asynchronous.
1559
1560=over 4
1561
1562=item IO::AIO::sendfile $ofh, $ifh, $offset, $count
1563
1564Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>,
1565but is blocking (this makes most sense if you know the input data is
1566likely cached already and the output filehandle is set to non-blocking
1567operations).
1568
1569Returns the number of bytes copied, or C<-1> on error.
1570
1571=item IO::AIO::fadvise $fh, $offset, $len, $advice
1572
1573Simply calls the C<posix_fadvise> function (see it's
1574manpage for details). The following advice constants are
1575avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,
1576C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>,
1577C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.
1578
1579On systems that do not implement C<posix_fadvise>, this function returns
1580ENOSYS, otherwise the return value of C<posix_fadvise>.
1581
1582=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
1583
1584Memory-maps a file (or anonymous memory range) and attaches it to the
1585given C<$scalar>, which will act like a string scalar.
1586
1587The only operations allowed on the scalar are C<substr>/C<vec> that don't
1588change the string length, and most read-only operations such as copying it
1589or searching it with regexes and so on.
1590
1591Anything else is unsafe and will, at best, result in memory leaks.
1592
1593The memory map associated with the C<$scalar> is automatically removed
1594when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or
1595C<IO::AIO::munmap> functions are called.
1596
1597This calls the C<mmap>(2) function internally. See your system's manual
1598page for details on the C<$length>, C<$prot> and C<$flags> parameters.
1599
1600The C<$length> must be larger than zero and smaller than the actual
1601filesize.
1602
1603C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,
1604C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,
1605
1606C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or
1607C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when
1608not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS>
1609(which is set to C<MAP_ANON> if your system only provides this
1610constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>,
1611C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or
1612C<IO::AIO::MAP_NONBLOCK>
1613
1614If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
1615
1616C<$offset> is the offset from the start of the file - it generally must be
1617a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.
1618
1619Example:
1620
1621 use Digest::MD5;
1622 use IO::AIO;
1623
1624 open my $fh, "<verybigfile"
1625 or die "$!";
1626
1627 IO::AIO::mmap my $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh
1628 or die "verybigfile: $!";
1629
1630 my $fast_md5 = md5 $data;
1631
1632=item IO::AIO::munmap $scalar
1633
1634Removes a previous mmap and undefines the C<$scalar>.
1635
1636=item IO::AIO::munlock $scalar, $offset = 0, $length = undef
1637
1638Calls the C<munlock> function, undoing the effects of a previous
1639C<aio_mlock> call (see its description for details).
1640
1641=item IO::AIO::munlockall
1642
1643Calls the C<munlockall> function.
1644
1645On systems that do not implement C<munlockall>, this function returns
1646ENOSYS, otherwise the return value of C<munlockall>.
1647
1648=back
1649
1335=cut 1650=cut
1336 1651
1337min_parallel 8; 1652min_parallel 8;
1338 1653
1339END { flush } 1654END { flush }
1340 1655
13411; 16561;
1657
1658=head1 EVENT LOOP INTEGRATION
1659
1660It is recommended to use L<AnyEvent::AIO> to integrate IO::AIO
1661automatically into many event loops:
1662
1663 # AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
1664 use AnyEvent::AIO;
1665
1666You can also integrate IO::AIO manually into many event loops, here are
1667some examples of how to do this:
1668
1669 # EV integration
1670 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
1671
1672 # Event integration
1673 Event->io (fd => IO::AIO::poll_fileno,
1674 poll => 'r',
1675 cb => \&IO::AIO::poll_cb);
1676
1677 # Glib/Gtk2 integration
1678 add_watch Glib::IO IO::AIO::poll_fileno,
1679 in => sub { IO::AIO::poll_cb; 1 };
1680
1681 # Tk integration
1682 Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
1683 readable => \&IO::AIO::poll_cb);
1684
1685 # Danga::Socket integration
1686 Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
1687 \&IO::AIO::poll_cb);
1342 1688
1343=head2 FORK BEHAVIOUR 1689=head2 FORK BEHAVIOUR
1344 1690
1345This module should do "the right thing" when the process using it forks: 1691This module should do "the right thing" when the process using it forks:
1346 1692

Diff Legend

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