… | |
… | |
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 | |
49 | This module implements asynchronous I/O using whatever means your |
53 | This module implements asynchronous I/O using whatever means your |
50 | operating system supports. |
54 | operating system supports. |
51 | |
55 | |
52 | Currently, a number of threads are started that execute your read/writes |
56 | Currently, a number of threads are started that execute your read/writes |
53 | and signal their completion. You don't need thread support in your libc or |
57 | and signal their completion. You don't need thread support in perl, and |
54 | perl, and the threads created by this module will not be visible to the |
58 | the threads created by this module will not be visible to perl. In the |
55 | pthreads library. In the future, this module might make use of the native |
59 | future, this module might make use of the native aio functions available |
56 | aio functions available on many operating systems. However, they are often |
60 | on many operating systems. However, they are often not well-supported |
57 | not well-supported (Linux doesn't allow them on normal files currently, |
61 | (Linux doesn't allow them on normal files currently, for example), |
58 | for example), and they would only support aio_read and aio_write, so the |
62 | and they would only support aio_read and aio_write, so the remaining |
59 | remaining functionality would have to be implemented using threads anyway. |
63 | functionality would have to be implemented using threads anyway. |
60 | |
64 | |
61 | Although the module will work with in the presence of other threads, it is |
65 | Although the module will work with in the presence of other threads, |
62 | currently not reentrant, so use appropriate locking yourself, always call |
66 | it is currently not reentrant in any way, so use appropriate locking |
63 | C<poll_cb> from within the same thread, or never call C<poll_cb> (or other |
67 | yourself, always call C<poll_cb> from within the same thread, or never |
64 | C<aio_> functions) recursively. |
68 | call C<poll_cb> (or other C<aio_> functions) recursively. |
65 | |
69 | |
66 | =cut |
70 | =cut |
67 | |
71 | |
68 | package IO::AIO; |
72 | package IO::AIO; |
69 | |
73 | |
… | |
… | |
71 | use strict 'vars'; |
75 | use strict 'vars'; |
72 | |
76 | |
73 | use base 'Exporter'; |
77 | use base 'Exporter'; |
74 | |
78 | |
75 | BEGIN { |
79 | BEGIN { |
76 | our $VERSION = '1.99'; |
80 | our $VERSION = '2.0'; |
77 | |
81 | |
78 | our @EXPORT = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat |
82 | 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 |
83 | 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 |
84 | aio_fsync aio_fdatasync aio_readahead aio_rename aio_link aio_move |
81 | aio_group); |
85 | aio_group aio_nop); |
82 | our @EXPORT_OK = qw(poll_fileno poll_cb min_parallel max_parallel max_outstanding nreqs); |
86 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
|
|
87 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
|
|
88 | min_parallel max_parallel max_outstanding nreqs); |
83 | |
89 | |
84 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
90 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
85 | |
91 | |
86 | require XSLoader; |
92 | require XSLoader; |
87 | XSLoader::load ("IO::AIO", $VERSION); |
93 | XSLoader::load ("IO::AIO", $VERSION); |
… | |
… | |
100 | syscall has been executed asynchronously. |
106 | syscall has been executed asynchronously. |
101 | |
107 | |
102 | All functions expecting a filehandle keep a copy of the filehandle |
108 | All functions expecting a filehandle keep a copy of the filehandle |
103 | internally until the request has finished. |
109 | internally until the request has finished. |
104 | |
110 | |
105 | All non-composite requests (requests that are not broken down into |
|
|
106 | multiple requests) return objects of type L<IO::AIO::REQ> that allow |
111 | All requests return objects of type L<IO::AIO::REQ> that allow further |
107 | further manipulation of running requests. |
112 | manipulation of those requests while they are in-flight. |
108 | |
113 | |
109 | The pathnames you pass to these routines I<must> be absolute and |
114 | The pathnames you pass to these routines I<must> be absolute and |
110 | encoded in byte form. The reason for the former is that at the time the |
115 | encoded in byte form. The reason for the former is that at the time the |
111 | request is being executed, the current working directory could have |
116 | request is being executed, the current working directory could have |
112 | changed. Alternatively, you can make sure that you never change the |
117 | changed. Alternatively, you can make sure that you never change the |
… | |
… | |
118 | your pathnames to the locale (or other) encoding in effect in the user |
123 | your pathnames to the locale (or other) encoding in effect in the user |
119 | environment, d) use Glib::filename_from_unicode on unicode filenames or e) |
124 | environment, d) use Glib::filename_from_unicode on unicode filenames or e) |
120 | use something else. |
125 | use something else. |
121 | |
126 | |
122 | =over 4 |
127 | =over 4 |
|
|
128 | |
|
|
129 | =item aioreq_pri $pri |
|
|
130 | |
|
|
131 | Sets the priority for the next aio request. The default priority |
|
|
132 | is C<0>, the minimum and maximum priorities are C<-4> and C<4>, |
|
|
133 | respectively. Requests with higher priority will be serviced first. |
|
|
134 | |
|
|
135 | The priority will be reset to C<0> after each call to one of the C<aio_> |
|
|
136 | functions. |
|
|
137 | |
|
|
138 | Example: open a file with low priority, then read something from it with |
|
|
139 | higher priority so the read request is serviced before other low priority |
|
|
140 | open requests (potentially spamming the cache): |
|
|
141 | |
|
|
142 | aioreq_pri -3; |
|
|
143 | aio_open ..., sub { |
|
|
144 | return unless $_[0]; |
|
|
145 | |
|
|
146 | aioreq_pri -2; |
|
|
147 | aio_read $_[0], ..., sub { |
|
|
148 | ... |
|
|
149 | }; |
|
|
150 | }; |
|
|
151 | |
|
|
152 | =item aioreq_nice $pri_adjust |
|
|
153 | |
|
|
154 | Similar to C<aioreq_pri>, but subtracts the given value from the current |
|
|
155 | priority, so effects are cumulative. |
123 | |
156 | |
124 | =item aio_open $pathname, $flags, $mode, $callback->($fh) |
157 | =item aio_open $pathname, $flags, $mode, $callback->($fh) |
125 | |
158 | |
126 | Asynchronously open or create a file and call the callback with a newly |
159 | Asynchronously open or create a file and call the callback with a newly |
127 | created filehandle for the file. |
160 | created filehandle for the file. |
… | |
… | |
180 | print "read $_[0] bytes: <$buffer>\n"; |
213 | print "read $_[0] bytes: <$buffer>\n"; |
181 | }; |
214 | }; |
182 | |
215 | |
183 | =item aio_move $srcpath, $dstpath, $callback->($status) |
216 | =item aio_move $srcpath, $dstpath, $callback->($status) |
184 | |
217 | |
|
|
218 | [EXPERIMENTAL due to internal aio_group use] |
|
|
219 | |
185 | Try to move the I<file> (directories not supported as either source or |
220 | Try to move the I<file> (directories not supported as either source or |
186 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
221 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
187 | the C<0> (error) or C<-1> ok. |
222 | the C<0> (error) or C<-1> ok. |
188 | |
223 | |
189 | This is a composite request that tries to rename(2) the file first. If |
224 | This is a composite request that tries to rename(2) the file first. If |
… | |
… | |
199 | =cut |
234 | =cut |
200 | |
235 | |
201 | sub aio_move($$$) { |
236 | sub aio_move($$$) { |
202 | my ($src, $dst, $cb) = @_; |
237 | my ($src, $dst, $cb) = @_; |
203 | |
238 | |
|
|
239 | my $grp = aio_group $cb; |
|
|
240 | |
204 | aio_rename $src, $dst, sub { |
241 | add $grp aio_rename $src, $dst, sub { |
205 | if ($_[0] && $! == EXDEV) { |
242 | if ($_[0] && $! == EXDEV) { |
206 | aio_open $src, O_RDONLY, 0, sub { |
243 | add $grp aio_open $src, O_RDONLY, 0, sub { |
207 | if (my $src_fh = $_[0]) { |
244 | if (my $src_fh = $_[0]) { |
208 | my @stat = stat $src_fh; |
245 | my @stat = stat $src_fh; |
209 | |
246 | |
210 | aio_open $dst, O_WRONLY, 0200, sub { |
247 | add $grp aio_open $dst, O_WRONLY, 0200, sub { |
211 | if (my $dst_fh = $_[0]) { |
248 | if (my $dst_fh = $_[0]) { |
212 | aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { |
249 | add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { |
213 | close $src_fh; |
250 | close $src_fh; |
214 | |
251 | |
215 | if ($_[0] == $stat[7]) { |
252 | if ($_[0] == $stat[7]) { |
216 | utime $stat[8], $stat[9], $dst; |
253 | utime $stat[8], $stat[9], $dst; |
217 | chmod $stat[2] & 07777, $dst_fh; |
254 | chmod $stat[2] & 07777, $dst_fh; |
218 | chown $stat[4], $stat[5], $dst_fh; |
255 | chown $stat[4], $stat[5], $dst_fh; |
219 | close $dst_fh; |
256 | close $dst_fh; |
220 | |
257 | |
221 | aio_unlink $src, sub { |
258 | add $grp aio_unlink $src, sub { |
222 | $cb->($_[0]); |
259 | $grp->result ($_[0]); |
223 | }; |
260 | }; |
224 | } else { |
261 | } else { |
225 | my $errno = $!; |
262 | my $errno = $!; |
226 | aio_unlink $dst, sub { |
263 | add $grp aio_unlink $dst, sub { |
227 | $! = $errno; |
264 | $! = $errno; |
228 | $cb->(-1); |
265 | $grp->result (-1); |
229 | }; |
266 | }; |
230 | } |
267 | } |
231 | }; |
268 | }; |
232 | } else { |
269 | } else { |
233 | $cb->(-1); |
270 | $grp->result (-1); |
234 | } |
271 | } |
235 | }, |
272 | }, |
236 | |
273 | |
237 | } else { |
274 | } else { |
238 | $cb->(-1); |
275 | $grp->result (-1); |
239 | } |
276 | } |
240 | }; |
277 | }; |
241 | } else { |
278 | } else { |
242 | $cb->($_[0]); |
279 | $grp->result ($_[0]); |
243 | } |
280 | } |
244 | }; |
281 | }; |
|
|
282 | |
|
|
283 | $grp |
245 | } |
284 | } |
246 | |
285 | |
247 | =item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
286 | =item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
248 | |
287 | |
249 | Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts |
288 | Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts |
… | |
… | |
337 | The callback a single argument which is either C<undef> or an array-ref |
376 | The callback a single argument which is either C<undef> or an array-ref |
338 | with the filenames. |
377 | with the filenames. |
339 | |
378 | |
340 | =item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
379 | =item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
341 | |
380 | |
|
|
381 | [EXPERIMENTAL due to internal aio_group use] |
|
|
382 | |
342 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
383 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
343 | separate the entries of directory C<$path> into two sets of names, ones |
384 | separate the entries of directory C<$path> into two sets of names, ones |
344 | you can recurse into (directories or links to them), and ones you cannot |
385 | you can recurse into (directories or links to them), and ones you cannot |
345 | recurse into (everything else). |
386 | recurse into (everything else). |
346 | |
387 | |
347 | C<aio_scandir> is a composite request that consists of many sub |
388 | C<aio_scandir> is a composite request that creates of many sub requests_ |
348 | requests. C<$maxreq> specifies the maximum number of outstanding aio |
389 | C<$maxreq> specifies the maximum number of outstanding aio requests that |
349 | requests that this function generates. If it is C<< <= 0 >>, then a |
390 | this function generates. If it is C<< <= 0 >>, then a suitable default |
350 | suitable default will be chosen (currently 8). |
391 | will be chosen (currently 6). |
351 | |
392 | |
352 | On error, the callback is called without arguments, otherwise it receives |
393 | On error, the callback is called without arguments, otherwise it receives |
353 | two array-refs with path-relative entry names. |
394 | two array-refs with path-relative entry names. |
354 | |
395 | |
355 | Example: |
396 | Example: |
… | |
… | |
392 | =cut |
433 | =cut |
393 | |
434 | |
394 | sub aio_scandir($$$) { |
435 | sub aio_scandir($$$) { |
395 | my ($path, $maxreq, $cb) = @_; |
436 | my ($path, $maxreq, $cb) = @_; |
396 | |
437 | |
|
|
438 | my $grp = aio_group $cb; |
|
|
439 | |
397 | $maxreq = 8 if $maxreq <= 0; |
440 | $maxreq = 6 if $maxreq <= 0; |
398 | |
441 | |
399 | # stat once |
442 | # stat once |
400 | aio_stat $path, sub { |
443 | add $grp aio_stat $path, sub { |
401 | return $cb->() if $_[0]; |
444 | return $grp->result () if $_[0]; |
402 | my $now = time; |
445 | my $now = time; |
403 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
446 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
404 | |
447 | |
405 | # read the directory entries |
448 | # read the directory entries |
406 | aio_readdir $path, sub { |
449 | add $grp aio_readdir $path, sub { |
407 | my $entries = shift |
450 | my $entries = shift |
408 | or return $cb->(); |
451 | or return $grp->result (); |
409 | |
452 | |
410 | # stat the dir another time |
453 | # stat the dir another time |
411 | aio_stat $path, sub { |
454 | add $grp aio_stat $path, sub { |
412 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
455 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
413 | |
456 | |
414 | my $ndirs; |
457 | my $ndirs; |
415 | |
458 | |
416 | # take the slow route if anything looks fishy |
459 | # take the slow route if anything looks fishy |
… | |
… | |
418 | $ndirs = -1; |
461 | $ndirs = -1; |
419 | } else { |
462 | } else { |
420 | # if nlink == 2, we are finished |
463 | # if nlink == 2, we are finished |
421 | # on non-posix-fs's, we rely on nlink < 2 |
464 | # on non-posix-fs's, we rely on nlink < 2 |
422 | $ndirs = (stat _)[3] - 2 |
465 | $ndirs = (stat _)[3] - 2 |
423 | or return $cb->([], $entries); |
466 | or return $grp->result ([], $entries); |
424 | } |
467 | } |
425 | |
468 | |
426 | # sort into likely dirs and likely nondirs |
469 | # sort into likely dirs and likely nondirs |
427 | # dirs == files without ".", short entries first |
470 | # dirs == files without ".", short entries first |
428 | $entries = [map $_->[0], |
471 | $entries = [map $_->[0], |
… | |
… | |
433 | my (@dirs, @nondirs); |
476 | my (@dirs, @nondirs); |
434 | |
477 | |
435 | my ($statcb, $schedcb); |
478 | my ($statcb, $schedcb); |
436 | my $nreq = 0; |
479 | my $nreq = 0; |
437 | |
480 | |
|
|
481 | my $statgrp = add $grp aio_group; |
|
|
482 | |
438 | $schedcb = sub { |
483 | $schedcb = sub { |
439 | if (@$entries) { |
484 | if (@$entries) { |
440 | if ($nreq < $maxreq) { |
485 | if ($nreq < $maxreq) { |
441 | my $ent = pop @$entries; |
486 | my $ent = pop @$entries; |
442 | $nreq++; |
487 | $nreq++; |
443 | aio_stat "$path/$ent/.", sub { $statcb->($_[0], $ent) }; |
488 | add $statgrp aio_stat "$path/$ent/.", sub { $statcb->($_[0], $ent) }; |
444 | } |
489 | } |
445 | } elsif (!$nreq) { |
490 | } elsif (!$nreq) { |
446 | # finished |
491 | # finished |
|
|
492 | $statgrp->cancel; |
447 | undef $statcb; |
493 | undef $statcb; |
448 | undef $schedcb; |
494 | undef $schedcb; |
449 | $cb->(\@dirs, \@nondirs) if $cb; |
495 | $grp->result (\@dirs, \@nondirs); |
450 | undef $cb; |
|
|
451 | } |
496 | } |
452 | }; |
497 | }; |
453 | $statcb = sub { |
498 | $statcb = sub { |
454 | my ($status, $entry) = @_; |
499 | my ($status, $entry) = @_; |
455 | |
500 | |
… | |
… | |
457 | $nreq--; |
502 | $nreq--; |
458 | push @nondirs, $entry; |
503 | push @nondirs, $entry; |
459 | &$schedcb; |
504 | &$schedcb; |
460 | } else { |
505 | } else { |
461 | # need to check for real directory |
506 | # need to check for real directory |
462 | aio_lstat "$path/$entry", sub { |
507 | add $grp aio_lstat "$path/$entry", sub { |
463 | $nreq--; |
508 | $nreq--; |
464 | |
509 | |
465 | if (-d _) { |
510 | if (-d _) { |
466 | push @dirs, $entry; |
511 | push @dirs, $entry; |
467 | |
512 | |
… | |
… | |
480 | |
525 | |
481 | &$schedcb while @$entries && $nreq < $maxreq; |
526 | &$schedcb while @$entries && $nreq < $maxreq; |
482 | }; |
527 | }; |
483 | }; |
528 | }; |
484 | }; |
529 | }; |
|
|
530 | |
|
|
531 | $grp |
485 | } |
532 | } |
486 | |
533 | |
487 | =item aio_fsync $fh, $callback->($status) |
534 | =item aio_fsync $fh, $callback->($status) |
488 | |
535 | |
489 | Asynchronously call fsync on the given filehandle and call the callback |
536 | Asynchronously call fsync on the given filehandle and call the callback |
… | |
… | |
495 | callback with the fdatasync result code. |
542 | callback with the fdatasync result code. |
496 | |
543 | |
497 | If this call isn't available because your OS lacks it or it couldn't be |
544 | If this call isn't available because your OS lacks it or it couldn't be |
498 | detected, it will be emulated by calling C<fsync> instead. |
545 | detected, it will be emulated by calling C<fsync> instead. |
499 | |
546 | |
500 | =item aio_group $callback->() |
547 | =item aio_group $callback->(...) |
501 | |
548 | |
|
|
549 | [EXPERIMENTAL] |
|
|
550 | |
|
|
551 | This is a very special aio request: Instead of doing something, it is a |
|
|
552 | container for other aio requests, which is useful if you want to bundle |
|
|
553 | many requests into a single, composite, request. |
|
|
554 | |
|
|
555 | Returns an object of class L<IO::AIO::GRP>. See its documentation below |
|
|
556 | for more info. |
|
|
557 | |
|
|
558 | Example: |
|
|
559 | |
|
|
560 | my $grp = aio_group sub { |
|
|
561 | print "all stats done\n"; |
|
|
562 | }; |
|
|
563 | |
|
|
564 | add $grp |
|
|
565 | (aio_stat ...), |
|
|
566 | (aio_stat ...), |
|
|
567 | ...; |
|
|
568 | |
|
|
569 | =item aio_nop $callback->() |
|
|
570 | |
|
|
571 | This is a special request - it does nothing in itself and is only used for |
|
|
572 | side effects, such as when you want to add a dummy request to a group so |
|
|
573 | that finishing the requests in the group depends on executing the given |
|
|
574 | code. |
|
|
575 | |
|
|
576 | While this request does nothing, it still goes through the execution |
|
|
577 | phase and still requires a worker thread. Thus, the callback will not |
|
|
578 | be executed immediately but only after other requests in the queue have |
|
|
579 | entered their execution phase. This can be used to measure request |
|
|
580 | latency. |
|
|
581 | |
502 | =item aio_sleep $fractional_seconds, $callback->() *NOT EXPORTED* |
582 | =item IO::AIO::aio_sleep $fractional_seconds, $callback->() *NOT EXPORTED* |
503 | |
583 | |
504 | Mainly used for debugging and benchmarking, this aio request puts one of |
584 | Mainly used for debugging and benchmarking, this aio request puts one of |
505 | the request workers to sleep for the given time. |
585 | the request workers to sleep for the given time. |
|
|
586 | |
|
|
587 | While it is theoretically handy to have simple I/O scheduling requests |
|
|
588 | like sleep and file handle readable/writable, the overhead this creates |
|
|
589 | is immense, so do not use this function except to put your application |
|
|
590 | under artificial I/O pressure. |
506 | |
591 | |
507 | =back |
592 | =back |
508 | |
593 | |
509 | =head2 IO::AIO::REQ CLASS |
594 | =head2 IO::AIO::REQ CLASS |
510 | |
595 | |
… | |
… | |
519 | callback) and B<done> (request has reached the end of its lifetime and |
604 | callback) and B<done> (request has reached the end of its lifetime and |
520 | holds no resources anymore). |
605 | holds no resources anymore). |
521 | |
606 | |
522 | =over 4 |
607 | =over 4 |
523 | |
608 | |
524 | =item $req->cancel |
609 | =item cancel $req |
525 | |
610 | |
526 | Cancels the request, if possible. Has the effect of skipping execution |
611 | Cancels the request, if possible. Has the effect of skipping execution |
527 | when entering the B<execute> state and skipping calling the callback when |
612 | when entering the B<execute> state and skipping calling the callback when |
528 | entering the the B<result> state, but will leave the request otherwise |
613 | entering the the B<result> state, but will leave the request otherwise |
529 | untouched. That means that requests that currently execute will not be |
614 | untouched. That means that requests that currently execute will not be |
530 | stopped and resources held by the request will not be freed prematurely. |
615 | stopped and resources held by the request will not be freed prematurely. |
531 | |
616 | |
|
|
617 | =item cb $req $callback->(...) |
|
|
618 | |
|
|
619 | Replace (or simply set) the callback registered to the request. |
|
|
620 | |
|
|
621 | =back |
|
|
622 | |
|
|
623 | =head2 IO::AIO::GRP CLASS |
|
|
624 | |
|
|
625 | This class is a subclass of L<IO::AIO::REQ>, so all its methods apply to |
|
|
626 | objects of this class, too. |
|
|
627 | |
|
|
628 | A IO::AIO::GRP object is a special request that can contain multiple other |
|
|
629 | aio requests. |
|
|
630 | |
|
|
631 | You create one by calling the C<aio_group> constructing function with a |
|
|
632 | callback that will be called when all contained requests have entered the |
|
|
633 | C<done> state: |
|
|
634 | |
|
|
635 | my $grp = aio_group sub { |
|
|
636 | print "all requests are done\n"; |
|
|
637 | }; |
|
|
638 | |
|
|
639 | You add requests by calling the C<add> method with one or more |
|
|
640 | C<IO::AIO::REQ> objects: |
|
|
641 | |
|
|
642 | $grp->add (aio_unlink "..."); |
|
|
643 | |
|
|
644 | add $grp aio_stat "...", sub { |
|
|
645 | $_[0] or return $grp->result ("error"); |
|
|
646 | |
|
|
647 | # add another request dynamically, if first succeeded |
|
|
648 | add $grp aio_open "...", sub { |
|
|
649 | $grp->result ("ok"); |
|
|
650 | }; |
|
|
651 | }; |
|
|
652 | |
|
|
653 | This makes it very easy to create composite requests (see the source of |
|
|
654 | C<aio_move> for an application) that work and feel like simple requests. |
|
|
655 | |
|
|
656 | =over 4 |
|
|
657 | |
|
|
658 | =item * The IO::AIO::GRP objects will be cleaned up during calls to |
|
|
659 | C<IO::AIO::poll_cb>, just like any other request. |
|
|
660 | |
|
|
661 | =item * They can be canceled like any other request. Canceling will cancel not |
|
|
662 | only the request itself, but also all requests it contains. |
|
|
663 | |
|
|
664 | =item * They can also can also be added to other IO::AIO::GRP objects. |
|
|
665 | |
|
|
666 | =item * You must not add requests to a group from within the group callback (or |
|
|
667 | any later time). |
|
|
668 | |
|
|
669 | =item * This does not harmonise well with C<max_outstanding>, so best do |
|
|
670 | not combine C<aio_group> with it. Groups and feeders are recommended for |
|
|
671 | this kind of concurrency-limiting. |
|
|
672 | |
|
|
673 | =back |
|
|
674 | |
|
|
675 | Their lifetime, simplified, looks like this: when they are empty, they |
|
|
676 | will finish very quickly. If they contain only requests that are in the |
|
|
677 | C<done> state, they will also finish. Otherwise they will continue to |
|
|
678 | exist. |
|
|
679 | |
|
|
680 | That means after creating a group you have some time to add requests. And |
|
|
681 | in the callbacks of those requests, you can add further requests to the |
|
|
682 | group. And only when all those requests have finished will the the group |
|
|
683 | itself finish. |
|
|
684 | |
|
|
685 | =over 4 |
|
|
686 | |
|
|
687 | =item add $grp ... |
|
|
688 | |
|
|
689 | =item $grp->add (...) |
|
|
690 | |
|
|
691 | Add one or more requests to the group. Any type of L<IO::AIO::REQ> can |
|
|
692 | be added, including other groups, as long as you do not create circular |
|
|
693 | dependencies. |
|
|
694 | |
|
|
695 | Returns all its arguments. |
|
|
696 | |
|
|
697 | =item $grp->result (...) |
|
|
698 | |
|
|
699 | Set the result value(s) that will be passed to the group callback when all |
|
|
700 | subrequests have finished. By default, no argument will be passed. |
|
|
701 | |
|
|
702 | =item feed $grp $callback->($grp) |
|
|
703 | |
|
|
704 | [VERY EXPERIMENTAL] |
|
|
705 | |
|
|
706 | Sets a feeder/generator on this group: every group can have an attached |
|
|
707 | generator that generates requests if idle. The idea behind this is that, |
|
|
708 | although you could just queue as many requests as you want in a group, |
|
|
709 | this might starve other requests for a potentially long time. For |
|
|
710 | example, C<aio_scandir> might generate hundreds of thousands C<aio_stat> |
|
|
711 | requests, delaying any later requests for a long time. |
|
|
712 | |
|
|
713 | To avoid this, and allow incremental generation of requests, you can |
|
|
714 | instead a group and set a feeder on it that generates those requests. The |
|
|
715 | feed callback will be called whenever there are few enough (see C<limit>, |
|
|
716 | below) requests active in the group itself and is expected to queue more |
|
|
717 | requests. |
|
|
718 | |
|
|
719 | The feed callback can queue as many requests as it likes (i.e. C<add> does |
|
|
720 | not impose any limits). |
|
|
721 | |
|
|
722 | If the feed does not queue more requests when called, it will be |
|
|
723 | automatically removed from the group. |
|
|
724 | |
|
|
725 | If the feed limit is C<0>, it will be set to C<2> automatically. |
|
|
726 | |
|
|
727 | Example: |
|
|
728 | |
|
|
729 | # stat all files in @files, but only ever use four aio requests concurrently: |
|
|
730 | |
|
|
731 | my $grp = aio_group sub { print "finished\n" }; |
|
|
732 | limit $grp 4; |
|
|
733 | feed $grp sub { |
|
|
734 | my $file = pop @files |
|
|
735 | or return; |
|
|
736 | |
|
|
737 | add $grp aio_stat $file, sub { ... }; |
|
|
738 | }; |
|
|
739 | |
|
|
740 | =item limit $grp $num |
|
|
741 | |
|
|
742 | Sets the feeder limit for the group: The feeder will be called whenever |
|
|
743 | the group contains less than this many requests. |
|
|
744 | |
|
|
745 | Setting the limit to C<0> will pause the feeding process. |
|
|
746 | |
532 | =back |
747 | =back |
533 | |
748 | |
534 | =head2 SUPPORT FUNCTIONS |
749 | =head2 SUPPORT FUNCTIONS |
535 | |
750 | |
536 | =over 4 |
751 | =over 4 |
… | |
… | |
593 | IO::AIO::poll_wait, IO::AIO::poll_cb |
808 | IO::AIO::poll_wait, IO::AIO::poll_cb |
594 | if IO::AIO::nreqs; |
809 | if IO::AIO::nreqs; |
595 | |
810 | |
596 | =item IO::AIO::min_parallel $nthreads |
811 | =item IO::AIO::min_parallel $nthreads |
597 | |
812 | |
598 | Set the minimum number of AIO threads to C<$nthreads>. The current default |
813 | Set the minimum number of AIO threads to C<$nthreads>. The current |
599 | is C<4>, which means four asynchronous operations can be done at one time |
814 | default is C<8>, which means eight asynchronous operations can execute |
600 | (the number of outstanding operations, however, is unlimited). |
815 | concurrently at any one time (the number of outstanding requests, |
|
|
816 | however, is unlimited). |
601 | |
817 | |
602 | IO::AIO starts threads only on demand, when an AIO request is queued and |
818 | IO::AIO starts threads only on demand, when an AIO request is queued and |
603 | no free thread exists. |
819 | no free thread exists. |
604 | |
820 | |
605 | It is recommended to keep the number of threads low, as some Linux |
821 | It is recommended to keep the number of threads relatively low, as some |
606 | kernel versions will scale negatively with the number of threads (higher |
822 | Linux kernel versions will scale negatively with the number of threads |
607 | parallelity => MUCH higher latency). With current Linux 2.6 versions, 4-32 |
823 | (higher parallelity => MUCH higher latency). With current Linux 2.6 |
608 | threads should be fine. |
824 | versions, 4-32 threads should be fine. |
609 | |
825 | |
610 | Under most circumstances you don't need to call this function, as the |
826 | Under most circumstances you don't need to call this function, as the |
611 | module selects a default that is suitable for low to moderate load. |
827 | module selects a default that is suitable for low to moderate load. |
612 | |
828 | |
613 | =item IO::AIO::max_parallel $nthreads |
829 | =item IO::AIO::max_parallel $nthreads |
… | |
… | |
624 | |
840 | |
625 | Under normal circumstances you don't need to call this function. |
841 | Under normal circumstances you don't need to call this function. |
626 | |
842 | |
627 | =item $oldnreqs = IO::AIO::max_outstanding $nreqs |
843 | =item $oldnreqs = IO::AIO::max_outstanding $nreqs |
628 | |
844 | |
|
|
845 | [DEPRECATED] |
|
|
846 | |
629 | Sets the maximum number of outstanding requests to C<$nreqs>. If you |
847 | Sets the maximum number of outstanding requests to C<$nreqs>. If you |
630 | try to queue up more than this number of requests, the caller will block until |
848 | try to queue up more than this number of requests, the caller will block until |
631 | some requests have been handled. |
849 | some requests have been handled. |
632 | |
850 | |
633 | The default is very large, so normally there is no practical limit. If you |
851 | The default is very large, so normally there is no practical limit. If you |
634 | queue up many requests in a loop it often improves speed if you set |
852 | queue up many requests in a loop it often improves speed if you set |
635 | this to a relatively low number, such as C<100>. |
853 | this to a relatively low number, such as C<100>. |
|
|
854 | |
|
|
855 | This function does not work well together with C<aio_group>'s, and their |
|
|
856 | feeder interface is better suited to limiting concurrency, so do not use |
|
|
857 | this function. |
636 | |
858 | |
637 | Under normal circumstances you don't need to call this function. |
859 | Under normal circumstances you don't need to call this function. |
638 | |
860 | |
639 | =back |
861 | =back |
640 | |
862 | |
… | |
… | |
654 | or return undef; |
876 | or return undef; |
655 | |
877 | |
656 | *$sym |
878 | *$sym |
657 | } |
879 | } |
658 | |
880 | |
659 | min_parallel 4; |
881 | min_parallel 8; |
660 | |
882 | |
661 | END { |
883 | END { |
662 | max_parallel 0; |
884 | max_parallel 0; |
663 | } |
885 | } |
664 | |
886 | |
… | |
… | |
678 | |
900 | |
679 | In short: the parent will, after a short pause, continue as if fork had |
901 | In short: the parent will, after a short pause, continue as if fork had |
680 | not been called, while the child will act as if IO::AIO has not been used |
902 | not been called, while the child will act as if IO::AIO has not been used |
681 | yet. |
903 | yet. |
682 | |
904 | |
|
|
905 | =head2 MEMORY USAGE |
|
|
906 | |
|
|
907 | Each aio request uses - depending on your architecture - around 128 bytes |
|
|
908 | of memory. In addition, stat requests need a stat buffer (possibly a few |
|
|
909 | hundred bytes). Perl scalars and other data passed into aio requests will |
|
|
910 | also be locked. |
|
|
911 | |
|
|
912 | This is now awfully much, so queuing lots of requests is not usually a |
|
|
913 | problem. |
|
|
914 | |
|
|
915 | Each thread needs a stack area which is usually around 16k, sometimes much |
|
|
916 | larger, depending on the OS. |
|
|
917 | |
683 | =head1 SEE ALSO |
918 | =head1 SEE ALSO |
684 | |
919 | |
685 | L<Coro>, L<Linux::AIO> (obsolete). |
920 | L<Coro::AIO>. |
686 | |
921 | |
687 | =head1 AUTHOR |
922 | =head1 AUTHOR |
688 | |
923 | |
689 | Marc Lehmann <schmorp@schmorp.de> |
924 | Marc Lehmann <schmorp@schmorp.de> |
690 | http://home.schmorp.de/ |
925 | http://home.schmorp.de/ |