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.51 by root, Sat Jun 24 19:14:04 2006 UTC vs.
Revision 1.87 by root, Sun Oct 29 00:52:02 2006 UTC

15 15
16 aio_read $fh, 30000, 1024, $buffer, 0, sub { 16 aio_read $fh, 30000, 1024, $buffer, 0, sub {
17 $_[0] > 0 or die "read error: $!"; 17 $_[0] > 0 or die "read error: $!";
18 }; 18 };
19 19
20 # AnyEvent 20 # version 2+ has request and group objects
21 use IO::AIO 2;
22
23 aioreq_pri 4; # give next request a very high priority
24 my $req = aio_unlink "/tmp/file", sub { };
25 $req->cancel; # cancel request if still in queue
26
27 my $grp = aio_group sub { print "all stats done\n" };
28 add $grp aio_stat "..." for ...;
29
30 # AnyEvent integration
21 open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!"; 31 open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!";
22 my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb }); 32 my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb });
23 33
24 # Event 34 # Event integration
25 Event->io (fd => IO::AIO::poll_fileno, 35 Event->io (fd => IO::AIO::poll_fileno,
26 poll => 'r', 36 poll => 'r',
27 cb => \&IO::AIO::poll_cb); 37 cb => \&IO::AIO::poll_cb);
28 38
29 # Glib/Gtk2 39 # Glib/Gtk2 integration
30 add_watch Glib::IO IO::AIO::poll_fileno, 40 add_watch Glib::IO IO::AIO::poll_fileno,
31 in => sub { IO::AIO::poll_cb; 1 }; 41 in => sub { IO::AIO::poll_cb; 1 };
32 42
33 # Tk 43 # Tk integration
34 Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "", 44 Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
35 readable => \&IO::AIO::poll_cb); 45 readable => \&IO::AIO::poll_cb);
36 46
37 # Danga::Socket 47 # Danga::Socket integration
38 Danga::Socket->AddOtherFds (IO::AIO::poll_fileno => 48 Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
39 \&IO::AIO::poll_cb); 49 \&IO::AIO::poll_cb);
40 50
41
42=head1 DESCRIPTION 51=head1 DESCRIPTION
43 52
44This module implements asynchronous I/O using whatever means your 53This module implements asynchronous I/O using whatever means your
45operating system supports. 54operating system supports.
46 55
56Asynchronous means that operations that can normally block your program
57(e.g. reading from disk) will be done asynchronously: the operation
58will still block, but you can do something else in the meantime. This
59is extremely useful for programs that need to stay interactive even
60when doing heavy I/O (GUI programs, high performance network servers
61etc.), but can also be used to easily do operations in parallel that are
62normally done sequentially, e.g. stat'ing many files, which is much faster
63on a RAID volume or over NFS when you do a number of stat operations
64concurrently.
65
66While this works on all types of file descriptors (for example sockets),
67using these functions on file descriptors that support nonblocking
68operation (again, sockets, pipes etc.) is very inefficient. Use an event
69loop for that (such as the L<Event|Event> module): IO::AIO will naturally
70fit into such an event loop itself.
71
47Currently, a number of threads are started that execute your read/writes 72In this version, a number of threads are started that execute your
48and signal their completion. You don't need thread support in your libc or 73requests and signal their completion. You don't need thread support
49perl, and the threads created by this module will not be visible to the 74in perl, and the threads created by this module will not be visible
50pthreads library. In the future, this module might make use of the native 75to perl. In the future, this module might make use of the native aio
51aio functions available on many operating systems. However, they are often 76functions available on many operating systems. However, they are often
52not well-supported (Linux doesn't allow them on normal files currently, 77not well-supported or restricted (GNU/Linux doesn't allow them on normal
53for example), and they would only support aio_read and aio_write, so the 78files currently, for example), and they would only support aio_read and
54remaining functionality would have to be implemented using threads anyway. 79aio_write, so the remaining functionality would have to be implemented
80using threads anyway.
55 81
56Although the module will work with in the presence of other threads, it is 82Although the module will work with in the presence of other (Perl-)
57currently not reentrant, so use appropriate locking yourself, always call 83threads, it is currently not reentrant in any way, so use appropriate
58C<poll_cb> from within the same thread, or never call C<poll_cb> (or other 84locking yourself, always call C<poll_cb> from within the same thread, or
59C<aio_> functions) recursively. 85never call C<poll_cb> (or other C<aio_> functions) recursively.
86
87=head2 EXAMPLE
88
89This is a simple example that uses the Event module and loads
90F</etc/passwd> asynchronously:
91
92 use Fcntl;
93 use Event;
94 use IO::AIO;
95
96 # register the IO::AIO callback with Event
97 Event->io (fd => IO::AIO::poll_fileno,
98 poll => 'r',
99 cb => \&IO::AIO::poll_cb);
100
101 # queue the request to open /etc/passwd
102 aio_open "/etc/passwd", O_RDONLY, 0, sub {
103 my $fh = $_[0]
104 or die "error while opening: $!";
105
106 # stat'ing filehandles is generally non-blocking
107 my $size = -s $fh;
108
109 # queue a request to read the file
110 my $contents;
111 aio_read $fh, 0, $size, $contents, 0, sub {
112 $_[0] == $size
113 or die "short read: $!";
114
115 close $fh;
116
117 # file contents now in $contents
118 print $contents;
119
120 # exit event loop and program
121 Event::unloop;
122 };
123 };
124
125 # possibly queue up other requests, or open GUI windows,
126 # check for sockets etc. etc.
127
128 # process events as long as there are some:
129 Event::loop;
130
131=head1 REQUEST ANATOMY AND LIFETIME
132
133Every C<aio_*> function creates a request. which is a C data structure not
134directly visible to Perl.
135
136If called in non-void context, every request function returns a Perl
137object representing the request. In void context, nothing is returned,
138which saves a bit of memory.
139
140The perl object is a fairly standard ref-to-hash object. The hash contents
141are not used by IO::AIO so you are free to store anything you like in it.
142
143During their existance, aio requests travel through the following states,
144in order:
145
146=over 4
147
148=item ready
149
150Immediately after a request is created it is put into the ready state,
151waiting for a thread to execute it.
152
153=item execute
154
155A thread has accepted the request for processing and is currently
156executing it (e.g. blocking in read).
157
158=item pending
159
160The request has been executed and is waiting for result processing.
161
162While request submission and execution is fully asynchronous, result
163processing is not and relies on the perl interpreter calling C<poll_cb>
164(or another function with the same effect).
165
166=item result
167
168The request results are processed synchronously by C<poll_cb>.
169
170The C<poll_cb> function will process all outstanding aio requests by
171calling their callbacks, freeing memory associated with them and managing
172any groups they are contained in.
173
174=item done
175
176Request has reached the end of its lifetime and holds no resources anymore
177(except possibly for the Perl object, but its connection to the actual
178aio request is severed and calling its methods will either do nothing or
179result in a runtime error).
60 180
61=cut 181=cut
62 182
63package IO::AIO; 183package IO::AIO;
64 184
66use strict 'vars'; 186use strict 'vars';
67 187
68use base 'Exporter'; 188use base 'Exporter';
69 189
70BEGIN { 190BEGIN {
71 our $VERSION = '1.8'; 191 our $VERSION = '2.1';
72 192
73 our @EXPORT = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat 193 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat
74 aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink 194 aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink
75 aio_fsync aio_fdatasync aio_readahead aio_rename aio_link aio_move); 195 aio_fsync aio_fdatasync aio_readahead aio_rename aio_link aio_move
76 our @EXPORT_OK = qw(poll_fileno poll_cb min_parallel max_parallel max_outstanding nreqs); 196 aio_copy aio_group aio_nop aio_mknod);
197 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
198 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
199 min_parallel max_parallel max_idle
200 nreqs nready npending nthreads
201 max_poll_time max_poll_reqs);
202
203 @IO::AIO::GRP::ISA = 'IO::AIO::REQ';
77 204
78 require XSLoader; 205 require XSLoader;
79 XSLoader::load ("IO::AIO", $VERSION); 206 XSLoader::load ("IO::AIO", $VERSION);
80} 207}
81 208
82=head1 FUNCTIONS 209=head1 FUNCTIONS
83 210
84=head2 AIO FUNCTIONS 211=head2 AIO REQUEST FUNCTIONS
85 212
86All the C<aio_*> calls are more or less thin wrappers around the syscall 213All the C<aio_*> calls are more or less thin wrappers around the syscall
87with the same name (sans C<aio_>). The arguments are similar or identical, 214with the same name (sans C<aio_>). The arguments are similar or identical,
88and they all accept an additional (and optional) C<$callback> argument 215and they all accept an additional (and optional) C<$callback> argument
89which must be a code reference. This code reference will get called with 216which must be a code reference. This code reference will get called with
92syscall has been executed asynchronously. 219syscall has been executed asynchronously.
93 220
94All functions expecting a filehandle keep a copy of the filehandle 221All functions expecting a filehandle keep a copy of the filehandle
95internally until the request has finished. 222internally until the request has finished.
96 223
224All functions return request objects of type L<IO::AIO::REQ> that allow
225further manipulation of those requests while they are in-flight.
226
97The pathnames you pass to these routines I<must> be absolute and 227The pathnames you pass to these routines I<must> be absolute and
98encoded in byte form. The reason for the former is that at the time the 228encoded as octets. The reason for the former is that at the time the
99request is being executed, the current working directory could have 229request is being executed, the current working directory could have
100changed. Alternatively, you can make sure that you never change the 230changed. Alternatively, you can make sure that you never change the
101current working directory. 231current working directory anywhere in the program and then use relative
232paths.
102 233
103To encode pathnames to byte form, either make sure you either: a) 234To encode pathnames as octets, either make sure you either: a) always pass
104always pass in filenames you got from outside (command line, readdir 235in filenames you got from outside (command line, readdir etc.) without
105etc.), b) are ASCII or ISO 8859-1, c) use the Encode module and encode 236tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module and encode
106your pathnames to the locale (or other) encoding in effect in the user 237your pathnames to the locale (or other) encoding in effect in the user
107environment, d) use Glib::filename_from_unicode on unicode filenames or e) 238environment, d) use Glib::filename_from_unicode on unicode filenames or e)
108use something else. 239use something else to ensure your scalar has the correct contents.
240
241This works, btw. independent of the internal UTF-8 bit, which IO::AIO
242handles correctly wether it is set or not.
109 243
110=over 4 244=over 4
245
246=item $prev_pri = aioreq_pri [$pri]
247
248Returns the priority value that would be used for the next request and, if
249C<$pri> is given, sets the priority for the next aio request.
250
251The default priority is C<0>, the minimum and maximum priorities are C<-4>
252and C<4>, respectively. Requests with higher priority will be serviced
253first.
254
255The priority will be reset to C<0> after each call to one of the C<aio_*>
256functions.
257
258Example: open a file with low priority, then read something from it with
259higher priority so the read request is serviced before other low priority
260open requests (potentially spamming the cache):
261
262 aioreq_pri -3;
263 aio_open ..., sub {
264 return unless $_[0];
265
266 aioreq_pri -2;
267 aio_read $_[0], ..., sub {
268 ...
269 };
270 };
271
272=item aioreq_nice $pri_adjust
273
274Similar to C<aioreq_pri>, but subtracts the given value from the current
275priority, so the effect is cumulative.
111 276
112=item aio_open $pathname, $flags, $mode, $callback->($fh) 277=item aio_open $pathname, $flags, $mode, $callback->($fh)
113 278
114Asynchronously open or create a file and call the callback with a newly 279Asynchronously open or create a file and call the callback with a newly
115created filehandle for the file. 280created filehandle for the file.
165 330
166 aio_read $fh, 7, 15, $buffer, 0, sub { 331 aio_read $fh, 7, 15, $buffer, 0, sub {
167 $_[0] > 0 or die "read error: $!"; 332 $_[0] > 0 or die "read error: $!";
168 print "read $_[0] bytes: <$buffer>\n"; 333 print "read $_[0] bytes: <$buffer>\n";
169 }; 334 };
170
171=item aio_move $srcpath, $dstpath, $callback->($status)
172
173[EXPERIMENTAL]
174
175Try to move the I<file> (directories not supported as either source or destination)
176from C<$srcpath> to C<$dstpath> and call the callback with the C<0> (error) or C<-1> ok.
177
178This is a composite request that tries to rename(2) the file first. If
179rename files with C<EXDEV>, it creates the destination file with mode 0200
180and copies the contents of the source file into it using C<aio_sendfile>,
181followed by restoring atime, mtime, access mode and uid/gid, in that
182order, and unlinking the C<$srcpath>.
183
184If an error occurs, the partial destination file will be unlinked, if
185possible, except when setting atime, mtime, access mode and uid/gid, where
186errors are being ignored.
187
188=cut
189
190sub aio_move($$$) {
191 my ($src, $dst, $cb) = @_;
192
193 aio_rename $src, $dst, sub {
194 if ($_[0] && $! == EXDEV) {
195 aio_open $src, O_RDONLY, 0, sub {
196 if (my $src_fh = $_[0]) {
197 my @stat = stat $src_fh;
198
199 aio_open $dst, O_WRONLY, 0200, sub {
200 if (my $dst_fh = $_[0]) {
201 aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
202 close $src_fh;
203
204 if ($_[0] == $stat[7]) {
205 utime $stat[8], $stat[9], $dst;
206 chmod $stat[2] & 07777, $dst_fh;
207 chown $stat[4], $stat[5], $dst_fh;
208 close $dst_fh;
209
210 aio_unlink $src, sub {
211 $cb->($_[0]);
212 };
213 } else {
214 my $errno = $!;
215 aio_unlink $dst, sub {
216 $! = $errno;
217 $cb->(-1);
218 };
219 }
220 };
221 } else {
222 $cb->(-1);
223 }
224 },
225
226 } else {
227 $cb->(-1);
228 }
229 };
230 } else {
231 $cb->($_[0]);
232 }
233 };
234}
235 335
236=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) 336=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
237 337
238Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts 338Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts
239reading at byte offset C<$in_offset>, and starts writing at the current 339reading at byte offset C<$in_offset>, and starts writing at the current
295=item aio_unlink $pathname, $callback->($status) 395=item aio_unlink $pathname, $callback->($status)
296 396
297Asynchronously unlink (delete) a file and call the callback with the 397Asynchronously unlink (delete) a file and call the callback with the
298result code. 398result code.
299 399
400=item aio_mknod $path, $mode, $dev, $callback->($status)
401
402[EXPERIMENTAL]
403
404Asynchronously create a device node (or fifo). See mknod(2).
405
406The only (POSIX-) portable way of calling this function is:
407
408 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ...
409
300=item aio_link $srcpath, $dstpath, $callback->($status) 410=item aio_link $srcpath, $dstpath, $callback->($status)
301 411
302Asynchronously create a new link to the existing object at C<$srcpath> at 412Asynchronously create a new link to the existing object at C<$srcpath> at
303the path C<$dstpath> and call the callback with the result code. 413the path C<$dstpath> and call the callback with the result code.
304 414
324sorted, and will B<NOT> include the C<.> and C<..> entries. 434sorted, and will B<NOT> include the C<.> and C<..> entries.
325 435
326The callback a single argument which is either C<undef> or an array-ref 436The callback a single argument which is either C<undef> or an array-ref
327with the filenames. 437with the filenames.
328 438
439=item aio_copy $srcpath, $dstpath, $callback->($status)
440
441Try to copy the I<file> (directories not supported as either source or
442destination) from C<$srcpath> to C<$dstpath> and call the callback with
443the C<0> (error) or C<-1> ok.
444
445This is a composite request that it creates the destination file with
446mode 0200 and copies the contents of the source file into it using
447C<aio_sendfile>, followed by restoring atime, mtime, access mode and
448uid/gid, in that order.
449
450If an error occurs, the partial destination file will be unlinked, if
451possible, except when setting atime, mtime, access mode and uid/gid, where
452errors are being ignored.
453
454=cut
455
456sub aio_copy($$;$) {
457 my ($src, $dst, $cb) = @_;
458
459 my $pri = aioreq_pri;
460 my $grp = aio_group $cb;
461
462 aioreq_pri $pri;
463 add $grp aio_open $src, O_RDONLY, 0, sub {
464 if (my $src_fh = $_[0]) {
465 my @stat = stat $src_fh;
466
467 aioreq_pri $pri;
468 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
469 if (my $dst_fh = $_[0]) {
470 aioreq_pri $pri;
471 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
472 if ($_[0] == $stat[7]) {
473 $grp->result (0);
474 close $src_fh;
475
476 # those should not normally block. should. should.
477 utime $stat[8], $stat[9], $dst;
478 chmod $stat[2] & 07777, $dst_fh;
479 chown $stat[4], $stat[5], $dst_fh;
480 close $dst_fh;
481 } else {
482 $grp->result (-1);
483 close $src_fh;
484 close $dst_fh;
485
486 aioreq $pri;
487 add $grp aio_unlink $dst;
488 }
489 };
490 } else {
491 $grp->result (-1);
492 }
493 },
494
495 } else {
496 $grp->result (-1);
497 }
498 };
499
500 $grp
501}
502
503=item aio_move $srcpath, $dstpath, $callback->($status)
504
505Try to move the I<file> (directories not supported as either source or
506destination) from C<$srcpath> to C<$dstpath> and call the callback with
507the C<0> (error) or C<-1> ok.
508
509This is a composite request that tries to rename(2) the file first. If
510rename files with C<EXDEV>, it copies the file with C<aio_copy> and, if
511that is successful, unlinking the C<$srcpath>.
512
513=cut
514
515sub aio_move($$;$) {
516 my ($src, $dst, $cb) = @_;
517
518 my $pri = aioreq_pri;
519 my $grp = aio_group $cb;
520
521 aioreq_pri $pri;
522 add $grp aio_rename $src, $dst, sub {
523 if ($_[0] && $! == EXDEV) {
524 aioreq_pri $pri;
525 add $grp aio_copy $src, $dst, sub {
526 $grp->result ($_[0]);
527
528 if (!$_[0]) {
529 aioreq_pri $pri;
530 add $grp aio_unlink $src;
531 }
532 };
533 } else {
534 $grp->result ($_[0]);
535 }
536 };
537
538 $grp
539}
540
329=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 541=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
330 542
331Scans a directory (similar to C<aio_readdir>) and tries to separate the 543Scans a directory (similar to C<aio_readdir>) but additionally tries to
332entries of directory C<$path> into two sets of names, ones you can recurse 544efficiently separate the entries of directory C<$path> into two sets of
333into (directories), and ones you cannot recurse into (everything else). 545names, directories you can recurse into (directories), and ones you cannot
546recurse into (everything else, including symlinks to directories).
334 547
335C<aio_scandir> is a composite request that consists of many 548C<aio_scandir> is a composite request that creates of many sub requests_
336aio-primitives. C<$maxreq> specifies the maximum number of outstanding 549C<$maxreq> specifies the maximum number of outstanding aio requests that
337aio requests that this function generates. If it is C<< <= 0 >>, then a 550this function generates. If it is C<< <= 0 >>, then a suitable default
338suitable default will be chosen (currently 8). 551will be chosen (currently 4).
339 552
340On error, the callback is called without arguments, otherwise it receives 553On error, the callback is called without arguments, otherwise it receives
341two array-refs with path-relative entry names. 554two array-refs with path-relative entry names.
342 555
343Example: 556Example:
351Implementation notes. 564Implementation notes.
352 565
353The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can. 566The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can.
354 567
355After reading the directory, the modification time, size etc. of the 568After reading the directory, the modification time, size etc. of the
356directory before and after the readdir is checked, and if they match, the 569directory before and after the readdir is checked, and if they match (and
357link count will be used to decide how many entries are directories (if 570isn't the current time), the link count will be used to decide how many
358>= 2). Otherwise, no knowledge of the number of subdirectories will be 571entries are directories (if >= 2). Otherwise, no knowledge of the number
359assumed. 572of subdirectories will be assumed.
360 573
361Then entires will be sorted into likely directories (everything without a 574Then entries will be sorted into likely directories (everything without
362non-initial dot) and likely non-directories (everything else). Then every 575a non-initial dot currently) and likely non-directories (everything
363entry + C</.> will be C<stat>'ed, likely directories first. This is often 576else). Then every entry plus an appended C</.> will be C<stat>'ed,
577likely directories first. If that succeeds, it assumes that the entry
578is a directory or a symlink to directory (which will be checked
579seperately). This is often faster than stat'ing the entry itself because
364faster because filesystems might detect the type of the entry without 580filesystems might detect the type of the entry without reading the inode
365reading the inode data (e.g. ext2fs filetype feature). If that succeeds, 581data (e.g. ext2fs filetype feature).
366it assumes that the entry is a directory or a symlink to directory (which
367will be checked seperately).
368 582
369If the known number of directories has been reached, the rest of the 583If the known number of directories (link count - 2) has been reached, the
370entries is assumed to be non-directories. 584rest of the entries is assumed to be non-directories.
585
586This only works with certainty on POSIX (= UNIX) filesystems, which
587fortunately are the vast majority of filesystems around.
588
589It will also likely work on non-POSIX filesystems with reduced efficiency
590as those tend to return 0 or 1 as link counts, which disables the
591directory counting heuristic.
371 592
372=cut 593=cut
373 594
374sub aio_scandir($$$) { 595sub aio_scandir($$$) {
375 my ($path, $maxreq, $cb) = @_; 596 my ($path, $maxreq, $cb) = @_;
376 597
598 my $pri = aioreq_pri;
599
600 my $grp = aio_group $cb;
601
377 $maxreq = 8 if $maxreq <= 0; 602 $maxreq = 4 if $maxreq <= 0;
378 603
379 # stat once 604 # stat once
605 aioreq_pri $pri;
380 aio_stat $path, sub { 606 add $grp aio_stat $path, sub {
381 return $cb->() if $_[0]; 607 return $grp->result () if $_[0];
608 my $now = time;
382 my $hash1 = join ":", (stat _)[0,1,3,7,9]; 609 my $hash1 = join ":", (stat _)[0,1,3,7,9];
383 610
384 # read the directory entries 611 # read the directory entries
612 aioreq_pri $pri;
385 aio_readdir $path, sub { 613 add $grp aio_readdir $path, sub {
386 my $entries = shift 614 my $entries = shift
387 or return $cb->(); 615 or return $grp->result ();
388 616
389 # stat the dir another time 617 # stat the dir another time
618 aioreq_pri $pri;
390 aio_stat $path, sub { 619 add $grp aio_stat $path, sub {
391 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 620 my $hash2 = join ":", (stat _)[0,1,3,7,9];
392 621
393 my $ndirs; 622 my $ndirs;
394 623
395 # take the slow route if anything looks fishy 624 # take the slow route if anything looks fishy
396 if ($hash1 ne $hash2) { 625 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
397 $ndirs = -1; 626 $ndirs = -1;
398 } else { 627 } else {
399 # if nlink == 2, we are finished 628 # if nlink == 2, we are finished
400 # on non-posix-fs's, we rely on nlink < 2 629 # on non-posix-fs's, we rely on nlink < 2
401 $ndirs = (stat _)[3] - 2 630 $ndirs = (stat _)[3] - 2
402 or return $cb->([], $entries); 631 or return $grp->result ([], $entries);
403 } 632 }
404 633
405 # sort into likely dirs and likely nondirs 634 # sort into likely dirs and likely nondirs
406 # dirs == files without ".", short entries first 635 # dirs == files without ".", short entries first
407 $entries = [map $_->[0], 636 $entries = [map $_->[0],
409 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], 638 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
410 @$entries]; 639 @$entries];
411 640
412 my (@dirs, @nondirs); 641 my (@dirs, @nondirs);
413 642
414 my ($statcb, $schedcb); 643 my $statgrp = add $grp aio_group sub {
415 my $nreq = 0; 644 $grp->result (\@dirs, \@nondirs);
645 };
416 646
417 $schedcb = sub { 647 limit $statgrp $maxreq;
418 if (@$entries) { 648 feed $statgrp sub {
419 if ($nreq < $maxreq) { 649 return unless @$entries;
420 my $ent = pop @$entries; 650 my $entry = pop @$entries;
651
652 aioreq_pri $pri;
653 add $statgrp aio_stat "$path/$entry/.", sub {
654 if ($_[0] < 0) {
655 push @nondirs, $entry;
656 } else {
657 # need to check for real directory
658 aioreq_pri $pri;
659 add $statgrp aio_lstat "$path/$entry", sub {
660 if (-d _) {
661 push @dirs, $entry;
662
663 unless (--$ndirs) {
664 push @nondirs, @$entries;
665 feed $statgrp;
666 }
667 } else {
668 push @nondirs, $entry;
669 }
421 $nreq++; 670 }
422 aio_stat "$path/$ent/.", sub { $statcb->($_[0], $ent) };
423 } 671 }
424 } elsif (!$nreq) {
425 # finished
426 undef $statcb;
427 undef $schedcb;
428 $cb->(\@dirs, \@nondirs) if $cb;
429 undef $cb;
430 } 672 };
431 }; 673 };
432 $statcb = sub {
433 my ($status, $entry) = @_;
434
435 if ($status < 0) {
436 $nreq--;
437 push @nondirs, $entry;
438 &$schedcb;
439 } else {
440 # need to check for real directory
441 aio_lstat "$path/$entry", sub {
442 $nreq--;
443
444 if (-d _) {
445 push @dirs, $entry;
446
447 if (!--$ndirs) {
448 push @nondirs, @$entries;
449 $entries = [];
450 }
451 } else {
452 push @nondirs, $entry;
453 }
454
455 &$schedcb;
456 }
457 }
458 };
459
460 &$schedcb while @$entries && $nreq < $maxreq;
461 }; 674 };
462 }; 675 };
463 }; 676 };
677
678 $grp
464} 679}
465 680
466=item aio_fsync $fh, $callback->($status) 681=item aio_fsync $fh, $callback->($status)
467 682
468Asynchronously call fsync on the given filehandle and call the callback 683Asynchronously call fsync on the given filehandle and call the callback
474callback with the fdatasync result code. 689callback with the fdatasync result code.
475 690
476If this call isn't available because your OS lacks it or it couldn't be 691If this call isn't available because your OS lacks it or it couldn't be
477detected, it will be emulated by calling C<fsync> instead. 692detected, it will be emulated by calling C<fsync> instead.
478 693
694=item aio_group $callback->(...)
695
696This is a very special aio request: Instead of doing something, it is a
697container for other aio requests, which is useful if you want to bundle
698many requests into a single, composite, request with a definite callback
699and the ability to cancel the whole request with its subrequests.
700
701Returns an object of class L<IO::AIO::GRP>. See its documentation below
702for more info.
703
704Example:
705
706 my $grp = aio_group sub {
707 print "all stats done\n";
708 };
709
710 add $grp
711 (aio_stat ...),
712 (aio_stat ...),
713 ...;
714
715=item aio_nop $callback->()
716
717This is a special request - it does nothing in itself and is only used for
718side effects, such as when you want to add a dummy request to a group so
719that finishing the requests in the group depends on executing the given
720code.
721
722While this request does nothing, it still goes through the execution
723phase and still requires a worker thread. Thus, the callback will not
724be executed immediately but only after other requests in the queue have
725entered their execution phase. This can be used to measure request
726latency.
727
728=item IO::AIO::aio_busy $fractional_seconds, $callback->() *NOT EXPORTED*
729
730Mainly used for debugging and benchmarking, this aio request puts one of
731the request workers to sleep for the given time.
732
733While it is theoretically handy to have simple I/O scheduling requests
734like sleep and file handle readable/writable, the overhead this creates is
735immense (it blocks a thread for a long time) so do not use this function
736except to put your application under artificial I/O pressure.
737
479=back 738=back
480 739
740=head2 IO::AIO::REQ CLASS
741
742All non-aggregate C<aio_*> functions return an object of this class when
743called in non-void context.
744
745=over 4
746
747=item cancel $req
748
749Cancels the request, if possible. Has the effect of skipping execution
750when entering the B<execute> state and skipping calling the callback when
751entering the the B<result> state, but will leave the request otherwise
752untouched. That means that requests that currently execute will not be
753stopped and resources held by the request will not be freed prematurely.
754
755=item cb $req $callback->(...)
756
757Replace (or simply set) the callback registered to the request.
758
759=back
760
761=head2 IO::AIO::GRP CLASS
762
763This class is a subclass of L<IO::AIO::REQ>, so all its methods apply to
764objects of this class, too.
765
766A IO::AIO::GRP object is a special request that can contain multiple other
767aio requests.
768
769You create one by calling the C<aio_group> constructing function with a
770callback that will be called when all contained requests have entered the
771C<done> state:
772
773 my $grp = aio_group sub {
774 print "all requests are done\n";
775 };
776
777You add requests by calling the C<add> method with one or more
778C<IO::AIO::REQ> objects:
779
780 $grp->add (aio_unlink "...");
781
782 add $grp aio_stat "...", sub {
783 $_[0] or return $grp->result ("error");
784
785 # add another request dynamically, if first succeeded
786 add $grp aio_open "...", sub {
787 $grp->result ("ok");
788 };
789 };
790
791This makes it very easy to create composite requests (see the source of
792C<aio_move> for an application) that work and feel like simple requests.
793
794=over 4
795
796=item * The IO::AIO::GRP objects will be cleaned up during calls to
797C<IO::AIO::poll_cb>, just like any other request.
798
799=item * They can be canceled like any other request. Canceling will cancel not
800only the request itself, but also all requests it contains.
801
802=item * They can also can also be added to other IO::AIO::GRP objects.
803
804=item * You must not add requests to a group from within the group callback (or
805any later time).
806
807=back
808
809Their lifetime, simplified, looks like this: when they are empty, they
810will finish very quickly. If they contain only requests that are in the
811C<done> state, they will also finish. Otherwise they will continue to
812exist.
813
814That means after creating a group you have some time to add requests. And
815in the callbacks of those requests, you can add further requests to the
816group. And only when all those requests have finished will the the group
817itself finish.
818
819=over 4
820
821=item add $grp ...
822
823=item $grp->add (...)
824
825Add one or more requests to the group. Any type of L<IO::AIO::REQ> can
826be added, including other groups, as long as you do not create circular
827dependencies.
828
829Returns all its arguments.
830
831=item $grp->cancel_subs
832
833Cancel all subrequests and clears any feeder, but not the group request
834itself. Useful when you queued a lot of events but got a result early.
835
836=item $grp->result (...)
837
838Set the result value(s) that will be passed to the group callback when all
839subrequests have finished and set thre groups errno to the current value
840of errno (just like calling C<errno> without an error number). By default,
841no argument will be passed and errno is zero.
842
843=item $grp->errno ([$errno])
844
845Sets the group errno value to C<$errno>, or the current value of errno
846when the argument is missing.
847
848Every aio request has an associated errno value that is restored when
849the callback is invoked. This method lets you change this value from its
850default (0).
851
852Calling C<result> will also set errno, so make sure you either set C<$!>
853before the call to C<result>, or call c<errno> after it.
854
855=item feed $grp $callback->($grp)
856
857Sets a feeder/generator on this group: every group can have an attached
858generator that generates requests if idle. The idea behind this is that,
859although you could just queue as many requests as you want in a group,
860this might starve other requests for a potentially long time. For
861example, C<aio_scandir> might generate hundreds of thousands C<aio_stat>
862requests, delaying any later requests for a long time.
863
864To avoid this, and allow incremental generation of requests, you can
865instead a group and set a feeder on it that generates those requests. The
866feed callback will be called whenever there are few enough (see C<limit>,
867below) requests active in the group itself and is expected to queue more
868requests.
869
870The feed callback can queue as many requests as it likes (i.e. C<add> does
871not impose any limits).
872
873If the feed does not queue more requests when called, it will be
874automatically removed from the group.
875
876If the feed limit is C<0>, it will be set to C<2> automatically.
877
878Example:
879
880 # stat all files in @files, but only ever use four aio requests concurrently:
881
882 my $grp = aio_group sub { print "finished\n" };
883 limit $grp 4;
884 feed $grp sub {
885 my $file = pop @files
886 or return;
887
888 add $grp aio_stat $file, sub { ... };
889 };
890
891=item limit $grp $num
892
893Sets the feeder limit for the group: The feeder will be called whenever
894the group contains less than this many requests.
895
896Setting the limit to C<0> will pause the feeding process.
897
898=back
899
481=head2 SUPPORT FUNCTIONS 900=head2 SUPPORT FUNCTIONS
901
902=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
482 903
483=over 4 904=over 4
484 905
485=item $fileno = IO::AIO::poll_fileno 906=item $fileno = IO::AIO::poll_fileno
486 907
491 912
492See C<poll_cb> for an example. 913See C<poll_cb> for an example.
493 914
494=item IO::AIO::poll_cb 915=item IO::AIO::poll_cb
495 916
496Process all outstanding events on the result pipe. You have to call this 917Process some outstanding events on the result pipe. You have to call this
497regularly. Returns the number of events processed. Returns immediately 918regularly. Returns the number of events processed. Returns immediately
498when no events are outstanding. 919when no events are outstanding. The amount of events processed depends on
920the settings of C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.
921
922If not all requests were processed for whatever reason, the filehandle
923will still be ready when C<poll_cb> returns.
499 924
500Example: Install an Event watcher that automatically calls 925Example: Install an Event watcher that automatically calls
501IO::AIO::poll_cb with high priority: 926IO::AIO::poll_cb with high priority:
502 927
503 Event->io (fd => IO::AIO::poll_fileno, 928 Event->io (fd => IO::AIO::poll_fileno,
504 poll => 'r', async => 1, 929 poll => 'r', async => 1,
505 cb => \&IO::AIO::poll_cb); 930 cb => \&IO::AIO::poll_cb);
506 931
932=item IO::AIO::max_poll_reqs $nreqs
933
934=item IO::AIO::max_poll_time $seconds
935
936These set the maximum number of requests (default C<0>, meaning infinity)
937that are being processed by C<IO::AIO::poll_cb> in one call, respectively
938the maximum amount of time (default C<0>, meaning infinity) spent in
939C<IO::AIO::poll_cb> to process requests (more correctly the mininum amount
940of time C<poll_cb> is allowed to use).
941
942Setting these is useful if you want to ensure some level of
943interactiveness when perl is not fast enough to process all requests in
944time.
945
946For interactive programs, values such as C<0.01> to C<0.1> should be fine.
947
948Example: Install an Event watcher that automatically calls
949IO::AIO::poll_some with low priority, to ensure that other parts of the
950program get the CPU sometimes even under high AIO load.
951
952 # try not to spend much more than 0.1s in poll_cb
953 IO::AIO::max_poll_time 0.1;
954
955 # use a low priority so other tasks have priority
956 Event->io (fd => IO::AIO::poll_fileno,
957 poll => 'r', nice => 1,
958 cb => &IO::AIO::poll_cb);
959
507=item IO::AIO::poll_wait 960=item IO::AIO::poll_wait
508 961
509Wait till the result filehandle becomes ready for reading (simply does a 962Wait till the result filehandle becomes ready for reading (simply does a
510C<select> on the filehandle. This is useful if you want to synchronously wait 963C<select> on the filehandle. This is useful if you want to synchronously
511for some requests to finish). 964wait for some requests to finish).
512 965
513See C<nreqs> for an example. 966See C<nreqs> for an example.
514 967
968=item IO::AIO::poll
969
970Waits until some requests have been handled.
971
972Strictly equivalent to:
973
974 IO::AIO::poll_wait, IO::AIO::poll_cb
975 if IO::AIO::nreqs;
976
515=item IO::AIO::nreqs 977=item IO::AIO::flush
516 978
517Returns the number of requests currently outstanding (i.e. for which their 979Wait till all outstanding AIO requests have been handled.
518callback has not been invoked yet).
519 980
520Example: wait till there are no outstanding requests anymore: 981Strictly equivalent to:
521 982
522 IO::AIO::poll_wait, IO::AIO::poll_cb 983 IO::AIO::poll_wait, IO::AIO::poll_cb
523 while IO::AIO::nreqs; 984 while IO::AIO::nreqs;
524 985
525=item IO::AIO::flush 986=head3 CONTROLLING THE NUMBER OF THREADS
526
527Wait till all outstanding AIO requests have been handled.
528
529Strictly equivalent to:
530
531 IO::AIO::poll_wait, IO::AIO::poll_cb
532 while IO::AIO::nreqs;
533
534=item IO::AIO::poll
535
536Waits until some requests have been handled.
537
538Strictly equivalent to:
539
540 IO::AIO::poll_wait, IO::AIO::poll_cb
541 if IO::AIO::nreqs;
542 987
543=item IO::AIO::min_parallel $nthreads 988=item IO::AIO::min_parallel $nthreads
544 989
545Set the minimum number of AIO threads to C<$nthreads>. The current default 990Set the minimum number of AIO threads to C<$nthreads>. The current
546is C<4>, which means four asynchronous operations can be done at one time 991default is C<8>, which means eight asynchronous operations can execute
547(the number of outstanding operations, however, is unlimited). 992concurrently at any one time (the number of outstanding requests,
993however, is unlimited).
548 994
549IO::AIO starts threads only on demand, when an AIO request is queued and 995IO::AIO starts threads only on demand, when an AIO request is queued and
550no free thread exists. 996no free thread exists. Please note that queueing up a hundred requests can
997create demand for a hundred threads, even if it turns out that everything
998is in the cache and could have been processed faster by a single thread.
551 999
552It is recommended to keep the number of threads low, as some Linux 1000It is recommended to keep the number of threads relatively low, as some
553kernel versions will scale negatively with the number of threads (higher 1001Linux kernel versions will scale negatively with the number of threads
554parallelity => MUCH higher latency). With current Linux 2.6 versions, 4-32 1002(higher parallelity => MUCH higher latency). With current Linux 2.6
555threads should be fine. 1003versions, 4-32 threads should be fine.
556 1004
557Under most circumstances you don't need to call this function, as the 1005Under most circumstances you don't need to call this function, as the
558module selects a default that is suitable for low to moderate load. 1006module selects a default that is suitable for low to moderate load.
559 1007
560=item IO::AIO::max_parallel $nthreads 1008=item IO::AIO::max_parallel $nthreads
569This module automatically runs C<max_parallel 0> at program end, to ensure 1017This module automatically runs C<max_parallel 0> at program end, to ensure
570that all threads are killed and that there are no outstanding requests. 1018that all threads are killed and that there are no outstanding requests.
571 1019
572Under normal circumstances you don't need to call this function. 1020Under normal circumstances you don't need to call this function.
573 1021
1022=item IO::AIO::max_idle $nthreads
1023
1024Limit the number of threads (default: 4) that are allowed to idle (i.e.,
1025threads that did not get a request to process within 10 seconds). That
1026means if a thread becomes idle while C<$nthreads> other threads are also
1027idle, it will free its resources and exit.
1028
1029This is useful when you allow a large number of threads (e.g. 100 or 1000)
1030to allow for extremely high load situations, but want to free resources
1031under normal circumstances (1000 threads can easily consume 30MB of RAM).
1032
1033The default is probably ok in most situations, especially if thread
1034creation is fast. If thread creation is very slow on your system you might
1035want to use larger values.
1036
574=item $oldnreqs = IO::AIO::max_outstanding $nreqs 1037=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs
1038
1039This is a very bad function to use in interactive programs because it
1040blocks, and a bad way to reduce concurrency because it is inexact: Better
1041use an C<aio_group> together with a feed callback.
575 1042
576Sets the maximum number of outstanding requests to C<$nreqs>. If you 1043Sets the maximum number of outstanding requests to C<$nreqs>. If you
577try to queue up more than this number of requests, the caller will block until 1044to queue up more than this number of requests, the next call to the
578some requests have been handled. 1045C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)
1046function will block until the limit is no longer exceeded.
579 1047
580The default is very large, so normally there is no practical limit. If you 1048The default value is very large, so there is no practical limit on the
581queue up many requests in a loop it often improves speed if you set 1049number of outstanding requests.
582this to a relatively low number, such as C<100>.
583 1050
584Under normal circumstances you don't need to call this function. 1051You can still queue as many requests as you want. Therefore,
1052C<max_oustsanding> is mainly useful in simple scripts (with low values) or
1053as a stop gap to shield against fatal memory overflow (with large values).
1054
1055=head3 STATISTICAL INFORMATION
1056
1057=item IO::AIO::nreqs
1058
1059Returns the number of requests currently in the ready, execute or pending
1060states (i.e. for which their callback has not been invoked yet).
1061
1062Example: wait till there are no outstanding requests anymore:
1063
1064 IO::AIO::poll_wait, IO::AIO::poll_cb
1065 while IO::AIO::nreqs;
1066
1067=item IO::AIO::nready
1068
1069Returns the number of requests currently in the ready state (not yet
1070executed).
1071
1072=item IO::AIO::npending
1073
1074Returns the number of requests currently in the pending state (executed,
1075but not yet processed by poll_cb).
585 1076
586=back 1077=back
587 1078
588=cut 1079=cut
589 1080
601 or return undef; 1092 or return undef;
602 1093
603 *$sym 1094 *$sym
604} 1095}
605 1096
606min_parallel 4; 1097min_parallel 8;
607 1098
608END { 1099END {
609 max_parallel 0; 1100 min_parallel 1;
610} 1101 flush;
1102};
611 1103
6121; 11041;
613 1105
614=head2 FORK BEHAVIOUR 1106=head2 FORK BEHAVIOUR
1107
1108This module should do "the right thing" when the process using it forks:
615 1109
616Before the fork, IO::AIO enters a quiescent state where no requests 1110Before the fork, IO::AIO enters a quiescent state where no requests
617can be added in other threads and no results will be processed. After 1111can be added in other threads and no results will be processed. After
618the fork the parent simply leaves the quiescent state and continues 1112the fork the parent simply leaves the quiescent state and continues
619request/result processing, while the child clears the request/result 1113request/result processing, while the child frees the request/result queue
620queue (so the requests started before the fork will only be handled in 1114(so that the requests started before the fork will only be handled in the
621the parent). Threats will be started on demand until the limit ste in the 1115parent). Threads will be started on demand until the limit set in the
622parent process has been reached again. 1116parent process has been reached again.
623 1117
1118In short: the parent will, after a short pause, continue as if fork had
1119not been called, while the child will act as if IO::AIO has not been used
1120yet.
1121
1122=head2 MEMORY USAGE
1123
1124Per-request usage:
1125
1126Each aio request uses - depending on your architecture - around 100-200
1127bytes of memory. In addition, stat requests need a stat buffer (possibly
1128a few hundred bytes), readdir requires a result buffer and so on. Perl
1129scalars and other data passed into aio requests will also be locked and
1130will consume memory till the request has entered the done state.
1131
1132This is now awfully much, so queuing lots of requests is not usually a
1133problem.
1134
1135Per-thread usage:
1136
1137In the execution phase, some aio requests require more memory for
1138temporary buffers, and each thread requires a stack and other data
1139structures (usually around 16k-128k, depending on the OS).
1140
1141=head1 KNOWN BUGS
1142
1143Known bugs will be fixed in the next release.
1144
624=head1 SEE ALSO 1145=head1 SEE ALSO
625 1146
626L<Coro>, L<Linux::AIO>. 1147L<Coro::AIO>.
627 1148
628=head1 AUTHOR 1149=head1 AUTHOR
629 1150
630 Marc Lehmann <schmorp@schmorp.de> 1151 Marc Lehmann <schmorp@schmorp.de>
631 http://home.schmorp.de/ 1152 http://home.schmorp.de/

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines