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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines