… | |
… | |
131 | our $VERSION = '2.0'; |
131 | our $VERSION = '2.0'; |
132 | |
132 | |
133 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat |
133 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat |
134 | aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink |
134 | aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink |
135 | aio_fsync aio_fdatasync aio_readahead aio_rename aio_link aio_move |
135 | aio_fsync aio_fdatasync aio_readahead aio_rename aio_link aio_move |
136 | aio_group aio_nop); |
136 | aio_copy aio_group aio_nop aio_mknod); |
137 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
137 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
138 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
138 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
139 | min_parallel max_parallel max_outstanding nreqs); |
139 | min_parallel max_parallel nreqs nready npending); |
140 | |
140 | |
141 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
141 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
142 | |
142 | |
143 | require XSLoader; |
143 | require XSLoader; |
144 | XSLoader::load ("IO::AIO", $VERSION); |
144 | XSLoader::load ("IO::AIO", $VERSION); |
… | |
… | |
175 | environment, d) use Glib::filename_from_unicode on unicode filenames or e) |
175 | environment, d) use Glib::filename_from_unicode on unicode filenames or e) |
176 | use something else. |
176 | use something else. |
177 | |
177 | |
178 | =over 4 |
178 | =over 4 |
179 | |
179 | |
180 | =item aioreq_pri $pri |
180 | =item $prev_pri = aioreq_pri [$pri] |
181 | |
181 | |
182 | Sets the priority for the next aio request. The default priority |
182 | Returns the priority value that would be used for the next request and, if |
|
|
183 | C<$pri> is given, sets the priority for the next aio request. |
|
|
184 | |
183 | is C<0>, the minimum and maximum priorities are C<-4> and C<4>, |
185 | The default priority is C<0>, the minimum and maximum priorities are C<-4> |
184 | respectively. Requests with higher priority will be serviced first. |
186 | and C<4>, respectively. Requests with higher priority will be serviced |
|
|
187 | first. |
185 | |
188 | |
186 | The priority will be reset to C<0> after each call to one of the C<aio_> |
189 | The priority will be reset to C<0> after each call to one of the C<aio_*> |
187 | functions. |
190 | functions. |
188 | |
191 | |
189 | Example: open a file with low priority, then read something from it with |
192 | Example: open a file with low priority, then read something from it with |
190 | higher priority so the read request is serviced before other low priority |
193 | higher priority so the read request is serviced before other low priority |
191 | open requests (potentially spamming the cache): |
194 | open requests (potentially spamming the cache): |
… | |
… | |
261 | |
264 | |
262 | aio_read $fh, 7, 15, $buffer, 0, sub { |
265 | aio_read $fh, 7, 15, $buffer, 0, sub { |
263 | $_[0] > 0 or die "read error: $!"; |
266 | $_[0] > 0 or die "read error: $!"; |
264 | print "read $_[0] bytes: <$buffer>\n"; |
267 | print "read $_[0] bytes: <$buffer>\n"; |
265 | }; |
268 | }; |
266 | |
|
|
267 | =item aio_move $srcpath, $dstpath, $callback->($status) |
|
|
268 | |
|
|
269 | Try to move the I<file> (directories not supported as either source or |
|
|
270 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
|
|
271 | the C<0> (error) or C<-1> ok. |
|
|
272 | |
|
|
273 | This is a composite request that tries to rename(2) the file first. If |
|
|
274 | rename files with C<EXDEV>, it creates the destination file with mode 0200 |
|
|
275 | and copies the contents of the source file into it using C<aio_sendfile>, |
|
|
276 | followed by restoring atime, mtime, access mode and uid/gid, in that |
|
|
277 | order, and unlinking the C<$srcpath>. |
|
|
278 | |
|
|
279 | If an error occurs, the partial destination file will be unlinked, if |
|
|
280 | possible, except when setting atime, mtime, access mode and uid/gid, where |
|
|
281 | errors are being ignored. |
|
|
282 | |
|
|
283 | =cut |
|
|
284 | |
|
|
285 | sub aio_move($$$) { |
|
|
286 | my ($src, $dst, $cb) = @_; |
|
|
287 | |
|
|
288 | my $grp = aio_group $cb; |
|
|
289 | |
|
|
290 | add $grp aio_rename $src, $dst, sub { |
|
|
291 | if ($_[0] && $! == EXDEV) { |
|
|
292 | add $grp aio_open $src, O_RDONLY, 0, sub { |
|
|
293 | if (my $src_fh = $_[0]) { |
|
|
294 | my @stat = stat $src_fh; |
|
|
295 | |
|
|
296 | add $grp aio_open $dst, O_WRONLY, 0200, sub { |
|
|
297 | if (my $dst_fh = $_[0]) { |
|
|
298 | add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { |
|
|
299 | close $src_fh; |
|
|
300 | |
|
|
301 | if ($_[0] == $stat[7]) { |
|
|
302 | utime $stat[8], $stat[9], $dst; |
|
|
303 | chmod $stat[2] & 07777, $dst_fh; |
|
|
304 | chown $stat[4], $stat[5], $dst_fh; |
|
|
305 | close $dst_fh; |
|
|
306 | |
|
|
307 | add $grp aio_unlink $src, sub { |
|
|
308 | $grp->result ($_[0]); |
|
|
309 | }; |
|
|
310 | } else { |
|
|
311 | my $errno = $!; |
|
|
312 | add $grp aio_unlink $dst, sub { |
|
|
313 | $! = $errno; |
|
|
314 | $grp->result (-1); |
|
|
315 | }; |
|
|
316 | } |
|
|
317 | }; |
|
|
318 | } else { |
|
|
319 | $grp->result (-1); |
|
|
320 | } |
|
|
321 | }, |
|
|
322 | |
|
|
323 | } else { |
|
|
324 | $grp->result (-1); |
|
|
325 | } |
|
|
326 | }; |
|
|
327 | } else { |
|
|
328 | $grp->result ($_[0]); |
|
|
329 | } |
|
|
330 | }; |
|
|
331 | |
|
|
332 | $grp |
|
|
333 | } |
|
|
334 | |
269 | |
335 | =item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
270 | =item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
336 | |
271 | |
337 | Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts |
272 | Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts |
338 | reading at byte offset C<$in_offset>, and starts writing at the current |
273 | reading at byte offset C<$in_offset>, and starts writing at the current |
… | |
… | |
394 | =item aio_unlink $pathname, $callback->($status) |
329 | =item aio_unlink $pathname, $callback->($status) |
395 | |
330 | |
396 | Asynchronously unlink (delete) a file and call the callback with the |
331 | Asynchronously unlink (delete) a file and call the callback with the |
397 | result code. |
332 | result code. |
398 | |
333 | |
|
|
334 | =item aio_mknod $path, $mode, $dev, $callback->($status) |
|
|
335 | |
|
|
336 | Asynchronously create a device node (or fifo). See mknod(2): the only |
|
|
337 | portable value for C<$mode> is C<S_IFIFO> ored with permissions, and C<0> |
|
|
338 | for C<$dev>. |
|
|
339 | |
399 | =item aio_link $srcpath, $dstpath, $callback->($status) |
340 | =item aio_link $srcpath, $dstpath, $callback->($status) |
400 | |
341 | |
401 | Asynchronously create a new link to the existing object at C<$srcpath> at |
342 | Asynchronously create a new link to the existing object at C<$srcpath> at |
402 | the path C<$dstpath> and call the callback with the result code. |
343 | the path C<$dstpath> and call the callback with the result code. |
403 | |
344 | |
… | |
… | |
423 | sorted, and will B<NOT> include the C<.> and C<..> entries. |
364 | sorted, and will B<NOT> include the C<.> and C<..> entries. |
424 | |
365 | |
425 | The callback a single argument which is either C<undef> or an array-ref |
366 | The callback a single argument which is either C<undef> or an array-ref |
426 | with the filenames. |
367 | with the filenames. |
427 | |
368 | |
|
|
369 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
|
|
370 | |
|
|
371 | Try to copy the I<file> (directories not supported as either source or |
|
|
372 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
|
|
373 | the C<0> (error) or C<-1> ok. |
|
|
374 | |
|
|
375 | This is a composite request that it creates the destination file with |
|
|
376 | mode 0200 and copies the contents of the source file into it using |
|
|
377 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
|
|
378 | uid/gid, in that order. |
|
|
379 | |
|
|
380 | If an error occurs, the partial destination file will be unlinked, if |
|
|
381 | possible, except when setting atime, mtime, access mode and uid/gid, where |
|
|
382 | errors are being ignored. |
|
|
383 | |
|
|
384 | =cut |
|
|
385 | |
|
|
386 | sub aio_copy($$;$) { |
|
|
387 | my ($src, $dst, $cb) = @_; |
|
|
388 | |
|
|
389 | my $pri = aioreq_pri; |
|
|
390 | my $grp = aio_group $cb; |
|
|
391 | |
|
|
392 | aioreq_pri $pri; |
|
|
393 | add $grp aio_open $src, O_RDONLY, 0, sub { |
|
|
394 | if (my $src_fh = $_[0]) { |
|
|
395 | my @stat = stat $src_fh; |
|
|
396 | |
|
|
397 | aioreq_pri $pri; |
|
|
398 | add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { |
|
|
399 | if (my $dst_fh = $_[0]) { |
|
|
400 | aioreq_pri $pri; |
|
|
401 | add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { |
|
|
402 | if ($_[0] == $stat[7]) { |
|
|
403 | $grp->result (0); |
|
|
404 | close $src_fh; |
|
|
405 | |
|
|
406 | # those should not normally block. should. should. |
|
|
407 | utime $stat[8], $stat[9], $dst; |
|
|
408 | chmod $stat[2] & 07777, $dst_fh; |
|
|
409 | chown $stat[4], $stat[5], $dst_fh; |
|
|
410 | close $dst_fh; |
|
|
411 | } else { |
|
|
412 | $grp->result (-1); |
|
|
413 | close $src_fh; |
|
|
414 | close $dst_fh; |
|
|
415 | |
|
|
416 | aioreq $pri; |
|
|
417 | add $grp aio_unlink $dst; |
|
|
418 | } |
|
|
419 | }; |
|
|
420 | } else { |
|
|
421 | $grp->result (-1); |
|
|
422 | } |
|
|
423 | }, |
|
|
424 | |
|
|
425 | } else { |
|
|
426 | $grp->result (-1); |
|
|
427 | } |
|
|
428 | }; |
|
|
429 | |
|
|
430 | $grp |
|
|
431 | } |
|
|
432 | |
|
|
433 | =item aio_move $srcpath, $dstpath, $callback->($status) |
|
|
434 | |
|
|
435 | Try to move the I<file> (directories not supported as either source or |
|
|
436 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
|
|
437 | the C<0> (error) or C<-1> ok. |
|
|
438 | |
|
|
439 | This is a composite request that tries to rename(2) the file first. If |
|
|
440 | rename files with C<EXDEV>, it copies the file with C<aio_copy> and, if |
|
|
441 | that is successful, unlinking the C<$srcpath>. |
|
|
442 | |
|
|
443 | =cut |
|
|
444 | |
|
|
445 | sub aio_move($$;$) { |
|
|
446 | my ($src, $dst, $cb) = @_; |
|
|
447 | |
|
|
448 | my $pri = aioreq_pri; |
|
|
449 | my $grp = aio_group $cb; |
|
|
450 | |
|
|
451 | aioreq_pri $pri; |
|
|
452 | add $grp aio_rename $src, $dst, sub { |
|
|
453 | if ($_[0] && $! == EXDEV) { |
|
|
454 | aioreq_pri $pri; |
|
|
455 | add $grp aio_copy $src, $dst, sub { |
|
|
456 | $grp->result ($_[0]); |
|
|
457 | |
|
|
458 | if (!$_[0]) { |
|
|
459 | aioreq_pri $pri; |
|
|
460 | add $grp aio_unlink $src; |
|
|
461 | } |
|
|
462 | }; |
|
|
463 | } else { |
|
|
464 | $grp->result ($_[0]); |
|
|
465 | } |
|
|
466 | }; |
|
|
467 | |
|
|
468 | $grp |
|
|
469 | } |
|
|
470 | |
428 | =item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
471 | =item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
429 | |
472 | |
430 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
473 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
431 | separate the entries of directory C<$path> into two sets of names, ones |
474 | efficiently separate the entries of directory C<$path> into two sets of |
432 | you can recurse into (directories or links to them), and ones you cannot |
475 | names, directories you can recurse into (directories), and ones you cannot |
433 | recurse into (everything else). |
476 | recurse into (everything else, including symlinks to directories). |
434 | |
477 | |
435 | C<aio_scandir> is a composite request that creates of many sub requests_ |
478 | C<aio_scandir> is a composite request that creates of many sub requests_ |
436 | C<$maxreq> specifies the maximum number of outstanding aio requests that |
479 | C<$maxreq> specifies the maximum number of outstanding aio requests that |
437 | this function generates. If it is C<< <= 0 >>, then a suitable default |
480 | this function generates. If it is C<< <= 0 >>, then a suitable default |
438 | will be chosen (currently 6). |
481 | will be chosen (currently 4). |
439 | |
482 | |
440 | On error, the callback is called without arguments, otherwise it receives |
483 | On error, the callback is called without arguments, otherwise it receives |
441 | two array-refs with path-relative entry names. |
484 | two array-refs with path-relative entry names. |
442 | |
485 | |
443 | Example: |
486 | Example: |
… | |
… | |
480 | =cut |
523 | =cut |
481 | |
524 | |
482 | sub aio_scandir($$$) { |
525 | sub aio_scandir($$$) { |
483 | my ($path, $maxreq, $cb) = @_; |
526 | my ($path, $maxreq, $cb) = @_; |
484 | |
527 | |
|
|
528 | my $pri = aioreq_pri; |
|
|
529 | |
485 | my $grp = aio_group $cb; |
530 | my $grp = aio_group $cb; |
486 | |
531 | |
487 | $maxreq = 6 if $maxreq <= 0; |
532 | $maxreq = 4 if $maxreq <= 0; |
488 | |
533 | |
489 | # stat once |
534 | # stat once |
|
|
535 | aioreq_pri $pri; |
490 | add $grp aio_stat $path, sub { |
536 | add $grp aio_stat $path, sub { |
491 | return $grp->result () if $_[0]; |
537 | return $grp->result () if $_[0]; |
492 | my $now = time; |
538 | my $now = time; |
493 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
539 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
494 | |
540 | |
495 | # read the directory entries |
541 | # read the directory entries |
|
|
542 | aioreq_pri $pri; |
496 | add $grp aio_readdir $path, sub { |
543 | add $grp aio_readdir $path, sub { |
497 | my $entries = shift |
544 | my $entries = shift |
498 | or return $grp->result (); |
545 | or return $grp->result (); |
499 | |
546 | |
500 | # stat the dir another time |
547 | # stat the dir another time |
|
|
548 | aioreq_pri $pri; |
501 | add $grp aio_stat $path, sub { |
549 | add $grp aio_stat $path, sub { |
502 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
550 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
503 | |
551 | |
504 | my $ndirs; |
552 | my $ndirs; |
505 | |
553 | |
… | |
… | |
520 | map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], |
568 | map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], |
521 | @$entries]; |
569 | @$entries]; |
522 | |
570 | |
523 | my (@dirs, @nondirs); |
571 | my (@dirs, @nondirs); |
524 | |
572 | |
525 | my ($statcb, $schedcb); |
|
|
526 | my $nreq = 0; |
|
|
527 | |
|
|
528 | my $statgrp = add $grp aio_group; |
573 | my $statgrp = add $grp aio_group sub { |
|
|
574 | $grp->result (\@dirs, \@nondirs); |
|
|
575 | }; |
529 | |
576 | |
530 | $schedcb = sub { |
577 | limit $statgrp $maxreq; |
531 | if (@$entries) { |
578 | feed $statgrp sub { |
532 | if ($nreq < $maxreq) { |
579 | return unless @$entries; |
533 | my $ent = pop @$entries; |
580 | my $entry = pop @$entries; |
|
|
581 | |
|
|
582 | aioreq_pri $pri; |
|
|
583 | add $statgrp aio_stat "$path/$entry/.", sub { |
|
|
584 | if ($_[0] < 0) { |
|
|
585 | push @nondirs, $entry; |
|
|
586 | } else { |
|
|
587 | # need to check for real directory |
|
|
588 | aioreq_pri $pri; |
|
|
589 | add $statgrp aio_lstat "$path/$entry", sub { |
|
|
590 | if (-d _) { |
|
|
591 | push @dirs, $entry; |
|
|
592 | |
|
|
593 | unless (--$ndirs) { |
|
|
594 | push @nondirs, @$entries; |
|
|
595 | feed $statgrp; |
|
|
596 | } |
|
|
597 | } else { |
|
|
598 | push @nondirs, $entry; |
|
|
599 | } |
534 | $nreq++; |
600 | } |
535 | add $statgrp aio_stat "$path/$ent/.", sub { $statcb->($_[0], $ent) }; |
|
|
536 | } |
601 | } |
537 | } elsif (!$nreq) { |
|
|
538 | # finished |
|
|
539 | $statgrp->cancel; |
|
|
540 | undef $statcb; |
|
|
541 | undef $schedcb; |
|
|
542 | $grp->result (\@dirs, \@nondirs); |
|
|
543 | } |
602 | }; |
544 | }; |
603 | }; |
545 | $statcb = sub { |
|
|
546 | my ($status, $entry) = @_; |
|
|
547 | |
|
|
548 | if ($status < 0) { |
|
|
549 | $nreq--; |
|
|
550 | push @nondirs, $entry; |
|
|
551 | &$schedcb; |
|
|
552 | } else { |
|
|
553 | # need to check for real directory |
|
|
554 | add $grp aio_lstat "$path/$entry", sub { |
|
|
555 | $nreq--; |
|
|
556 | |
|
|
557 | if (-d _) { |
|
|
558 | push @dirs, $entry; |
|
|
559 | |
|
|
560 | if (!--$ndirs) { |
|
|
561 | push @nondirs, @$entries; |
|
|
562 | $entries = []; |
|
|
563 | } |
|
|
564 | } else { |
|
|
565 | push @nondirs, $entry; |
|
|
566 | } |
|
|
567 | |
|
|
568 | &$schedcb; |
|
|
569 | } |
|
|
570 | } |
|
|
571 | }; |
|
|
572 | |
|
|
573 | &$schedcb while @$entries && $nreq < $maxreq; |
|
|
574 | }; |
604 | }; |
575 | }; |
605 | }; |
576 | }; |
606 | }; |
577 | |
607 | |
578 | $grp |
608 | $grp |
… | |
… | |
590 | |
620 | |
591 | If this call isn't available because your OS lacks it or it couldn't be |
621 | If this call isn't available because your OS lacks it or it couldn't be |
592 | detected, it will be emulated by calling C<fsync> instead. |
622 | detected, it will be emulated by calling C<fsync> instead. |
593 | |
623 | |
594 | =item aio_group $callback->(...) |
624 | =item aio_group $callback->(...) |
595 | |
|
|
596 | [EXPERIMENTAL] |
|
|
597 | |
625 | |
598 | This is a very special aio request: Instead of doing something, it is a |
626 | This is a very special aio request: Instead of doing something, it is a |
599 | container for other aio requests, which is useful if you want to bundle |
627 | container for other aio requests, which is useful if you want to bundle |
600 | many requests into a single, composite, request with a definite callback |
628 | many requests into a single, composite, request with a definite callback |
601 | and the ability to cancel the whole request with its subrequests. |
629 | and the ability to cancel the whole request with its subrequests. |
… | |
… | |
704 | =item * They can also can also be added to other IO::AIO::GRP objects. |
732 | =item * They can also can also be added to other IO::AIO::GRP objects. |
705 | |
733 | |
706 | =item * You must not add requests to a group from within the group callback (or |
734 | =item * You must not add requests to a group from within the group callback (or |
707 | any later time). |
735 | any later time). |
708 | |
736 | |
709 | =item * This does not harmonise well with C<max_outstanding>, so best do |
|
|
710 | not combine C<aio_group> with it. Groups and feeders are recommended for |
|
|
711 | this kind of concurrency-limiting. |
|
|
712 | |
|
|
713 | =back |
737 | =back |
714 | |
738 | |
715 | Their lifetime, simplified, looks like this: when they are empty, they |
739 | Their lifetime, simplified, looks like this: when they are empty, they |
716 | will finish very quickly. If they contain only requests that are in the |
740 | will finish very quickly. If they contain only requests that are in the |
717 | C<done> state, they will also finish. Otherwise they will continue to |
741 | C<done> state, they will also finish. Otherwise they will continue to |
… | |
… | |
732 | be added, including other groups, as long as you do not create circular |
756 | be added, including other groups, as long as you do not create circular |
733 | dependencies. |
757 | dependencies. |
734 | |
758 | |
735 | Returns all its arguments. |
759 | Returns all its arguments. |
736 | |
760 | |
|
|
761 | =item $grp->cancel_subs |
|
|
762 | |
|
|
763 | Cancel all subrequests and clears any feeder, but not the group request |
|
|
764 | itself. Useful when you queued a lot of events but got a result early. |
|
|
765 | |
737 | =item $grp->result (...) |
766 | =item $grp->result (...) |
738 | |
767 | |
739 | Set the result value(s) that will be passed to the group callback when all |
768 | Set the result value(s) that will be passed to the group callback when all |
740 | subrequests have finished. By default, no argument will be passed. |
769 | subrequests have finished and set thre groups errno to the current value |
|
|
770 | of errno (just like calling C<errno> without an error number). By default, |
|
|
771 | no argument will be passed and errno is zero. |
|
|
772 | |
|
|
773 | =item $grp->errno ([$errno]) |
|
|
774 | |
|
|
775 | Sets the group errno value to C<$errno>, or the current value of errno |
|
|
776 | when the argument is missing. |
|
|
777 | |
|
|
778 | Every aio request has an associated errno value that is restored when |
|
|
779 | the callback is invoked. This method lets you change this value from its |
|
|
780 | default (0). |
|
|
781 | |
|
|
782 | Calling C<result> will also set errno, so make sure you either set C<$!> |
|
|
783 | before the call to C<result>, or call c<errno> after it. |
741 | |
784 | |
742 | =item feed $grp $callback->($grp) |
785 | =item feed $grp $callback->($grp) |
743 | |
|
|
744 | [VERY EXPERIMENTAL] |
|
|
745 | |
786 | |
746 | Sets a feeder/generator on this group: every group can have an attached |
787 | Sets a feeder/generator on this group: every group can have an attached |
747 | generator that generates requests if idle. The idea behind this is that, |
788 | generator that generates requests if idle. The idea behind this is that, |
748 | although you could just queue as many requests as you want in a group, |
789 | although you could just queue as many requests as you want in a group, |
749 | this might starve other requests for a potentially long time. For |
790 | this might starve other requests for a potentially long time. For |
… | |
… | |
803 | |
844 | |
804 | Process all outstanding events on the result pipe. You have to call this |
845 | Process all outstanding events on the result pipe. You have to call this |
805 | regularly. Returns the number of events processed. Returns immediately |
846 | regularly. Returns the number of events processed. Returns immediately |
806 | when no events are outstanding. |
847 | when no events are outstanding. |
807 | |
848 | |
|
|
849 | If not all requests were processed for whatever reason, the filehandle |
|
|
850 | will still be ready when C<poll_cb> returns. |
|
|
851 | |
808 | Example: Install an Event watcher that automatically calls |
852 | Example: Install an Event watcher that automatically calls |
809 | IO::AIO::poll_cb with high priority: |
853 | IO::AIO::poll_cb with high priority: |
810 | |
854 | |
811 | Event->io (fd => IO::AIO::poll_fileno, |
855 | Event->io (fd => IO::AIO::poll_fileno, |
812 | poll => 'r', async => 1, |
856 | poll => 'r', async => 1, |
813 | cb => \&IO::AIO::poll_cb); |
857 | cb => \&IO::AIO::poll_cb); |
814 | |
858 | |
|
|
859 | =item IO::AIO::poll_some $max_requests |
|
|
860 | |
|
|
861 | Similar to C<poll_cb>, but only processes up to C<$max_requests> requests |
|
|
862 | at a time. |
|
|
863 | |
|
|
864 | Useful if you want to ensure some level of interactiveness when perl is |
|
|
865 | not fast enough to process all requests in time. |
|
|
866 | |
|
|
867 | Example: Install an Event watcher that automatically calls |
|
|
868 | IO::AIO::poll_some with low priority, to ensure that other parts of the |
|
|
869 | program get the CPU sometimes even under high AIO load. |
|
|
870 | |
|
|
871 | Event->io (fd => IO::AIO::poll_fileno, |
|
|
872 | poll => 'r', nice => 1, |
|
|
873 | cb => sub { IO::AIO::poll_some 256 }); |
|
|
874 | |
815 | =item IO::AIO::poll_wait |
875 | =item IO::AIO::poll_wait |
816 | |
876 | |
817 | Wait till the result filehandle becomes ready for reading (simply does a |
877 | Wait till the result filehandle becomes ready for reading (simply does a |
818 | C<select> on the filehandle. This is useful if you want to synchronously wait |
878 | C<select> on the filehandle. This is useful if you want to synchronously wait |
819 | for some requests to finish). |
879 | for some requests to finish). |
820 | |
880 | |
821 | See C<nreqs> for an example. |
881 | See C<nreqs> for an example. |
822 | |
882 | |
823 | =item IO::AIO::nreqs |
883 | =item IO::AIO::nreqs |
824 | |
884 | |
825 | Returns the number of requests currently outstanding (i.e. for which their |
885 | Returns the number of requests currently in the ready, execute or pending |
826 | callback has not been invoked yet). |
886 | states (i.e. for which their callback has not been invoked yet). |
827 | |
887 | |
828 | Example: wait till there are no outstanding requests anymore: |
888 | Example: wait till there are no outstanding requests anymore: |
829 | |
889 | |
830 | IO::AIO::poll_wait, IO::AIO::poll_cb |
890 | IO::AIO::poll_wait, IO::AIO::poll_cb |
831 | while IO::AIO::nreqs; |
891 | while IO::AIO::nreqs; |
|
|
892 | |
|
|
893 | =item IO::AIO::nready |
|
|
894 | |
|
|
895 | Returns the number of requests currently in the ready state (not yet |
|
|
896 | executed). |
|
|
897 | |
|
|
898 | =item IO::AIO::npending |
|
|
899 | |
|
|
900 | Returns the number of requests currently in the pending state (executed, |
|
|
901 | but not yet processed by poll_cb). |
832 | |
902 | |
833 | =item IO::AIO::flush |
903 | =item IO::AIO::flush |
834 | |
904 | |
835 | Wait till all outstanding AIO requests have been handled. |
905 | Wait till all outstanding AIO requests have been handled. |
836 | |
906 | |
… | |
… | |
878 | This module automatically runs C<max_parallel 0> at program end, to ensure |
948 | This module automatically runs C<max_parallel 0> at program end, to ensure |
879 | that all threads are killed and that there are no outstanding requests. |
949 | that all threads are killed and that there are no outstanding requests. |
880 | |
950 | |
881 | Under normal circumstances you don't need to call this function. |
951 | Under normal circumstances you don't need to call this function. |
882 | |
952 | |
883 | =item $oldnreqs = IO::AIO::max_outstanding $nreqs |
953 | =item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs |
884 | |
954 | |
885 | [DEPRECATED] |
955 | This is a very bad function to use in interactive programs because it |
|
|
956 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
|
|
957 | use an C<aio_group> together with a feed callback. |
886 | |
958 | |
887 | Sets the maximum number of outstanding requests to C<$nreqs>. If you |
959 | Sets the maximum number of outstanding requests to C<$nreqs>. If you |
888 | try to queue up more than this number of requests, the caller will block until |
960 | to queue up more than this number of requests, the next call to the |
889 | some requests have been handled. |
961 | C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>) |
|
|
962 | function will block until the limit is no longer exceeded. |
890 | |
963 | |
891 | The default is very large, so normally there is no practical limit. If you |
964 | The default value is very large, so there is no practical limit on the |
892 | queue up many requests in a loop it often improves speed if you set |
965 | number of outstanding requests. |
893 | this to a relatively low number, such as C<100>. |
|
|
894 | |
966 | |
895 | This function does not work well together with C<aio_group>'s, and their |
967 | You can still queue as many requests as you want. Therefore, |
896 | feeder interface is better suited to limiting concurrency, so do not use |
968 | C<max_oustsanding> is mainly useful in simple scripts (with low values) or |
897 | this function. |
969 | as a stop gap to shield against fatal memory overflow (with large values). |
898 | |
|
|
899 | Under normal circumstances you don't need to call this function. |
|
|
900 | |
970 | |
901 | =back |
971 | =back |
902 | |
972 | |
903 | =cut |
973 | =cut |
904 | |
974 | |
… | |
… | |
919 | } |
989 | } |
920 | |
990 | |
921 | min_parallel 8; |
991 | min_parallel 8; |
922 | |
992 | |
923 | END { |
993 | END { |
924 | max_parallel 0; |
994 | flush; |
925 | } |
995 | }; |
926 | |
996 | |
927 | 1; |
997 | 1; |
928 | |
998 | |
929 | =head2 FORK BEHAVIOUR |
999 | =head2 FORK BEHAVIOUR |
930 | |
1000 | |
… | |
… | |
936 | request/result processing, while the child frees the request/result queue |
1006 | request/result processing, while the child frees the request/result queue |
937 | (so that the requests started before the fork will only be handled in the |
1007 | (so that the requests started before the fork will only be handled in the |
938 | parent). Threads will be started on demand until the limit set in the |
1008 | parent). Threads will be started on demand until the limit set in the |
939 | parent process has been reached again. |
1009 | parent process has been reached again. |
940 | |
1010 | |
941 | Temporary memory that was allocated for request processing is not |
|
|
942 | reclaimed in the child, however. While this is possible in some cases, it |
|
|
943 | is almost impossible in others (threads are evil you know), so you will |
|
|
944 | have to live with it. This is around 64k buffer (for sendfile, readahead |
|
|
945 | emulation) + the size of the directory being scanned (readdir). |
|
|
946 | |
|
|
947 | In short: the parent will, after a short pause, continue as if fork had |
1011 | In short: the parent will, after a short pause, continue as if fork had |
948 | not been called, while the child will act as if IO::AIO has not been used |
1012 | not been called, while the child will act as if IO::AIO has not been used |
949 | yet. |
1013 | yet. |
950 | |
1014 | |
951 | =head2 MEMORY USAGE |
1015 | =head2 MEMORY USAGE |
… | |
… | |
967 | temporary buffers, and each thread requires a stack and other data |
1031 | temporary buffers, and each thread requires a stack and other data |
968 | structures (usually around 16k-128k, depending on the OS). |
1032 | structures (usually around 16k-128k, depending on the OS). |
969 | |
1033 | |
970 | =head1 KNOWN BUGS |
1034 | =head1 KNOWN BUGS |
971 | |
1035 | |
972 | See FORK BEHAVIOUR, above. |
1036 | Known bugs will be fixed in the next release. |
973 | |
1037 | |
974 | =head1 SEE ALSO |
1038 | =head1 SEE ALSO |
975 | |
1039 | |
976 | L<Coro::AIO>. |
1040 | L<Coro::AIO>. |
977 | |
1041 | |