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.58 by root, Sun Oct 22 10:33:19 2006 UTC vs.
Revision 1.88 by root, Sun Oct 29 01:50:29 2006 UTC

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

Diff Legend

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