… | |
… | |
26 | $req->cancel; # cancel request if still in queue |
26 | $req->cancel; # cancel request if still in queue |
27 | |
27 | |
28 | my $grp = aio_group sub { print "all stats done\n" }; |
28 | my $grp = aio_group sub { print "all stats done\n" }; |
29 | add $grp aio_stat "..." for ...; |
29 | add $grp aio_stat "..." for ...; |
30 | |
30 | |
|
|
31 | # AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...) |
|
|
32 | use AnyEvent::AIO; |
|
|
33 | |
31 | # AnyEvent integration |
34 | # EV integration |
32 | open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!"; |
35 | my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; |
33 | my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb }); |
|
|
34 | |
36 | |
35 | # Event integration |
37 | # Event integration |
36 | Event->io (fd => IO::AIO::poll_fileno, |
38 | Event->io (fd => IO::AIO::poll_fileno, |
37 | poll => 'r', |
39 | poll => 'r', |
38 | cb => \&IO::AIO::poll_cb); |
40 | cb => \&IO::AIO::poll_cb); |
… | |
… | |
62 | etc.), but can also be used to easily do operations in parallel that are |
64 | etc.), but can also be used to easily do operations in parallel that are |
63 | normally done sequentially, e.g. stat'ing many files, which is much faster |
65 | normally done sequentially, e.g. stat'ing many files, which is much faster |
64 | on a RAID volume or over NFS when you do a number of stat operations |
66 | on a RAID volume or over NFS when you do a number of stat operations |
65 | concurrently. |
67 | concurrently. |
66 | |
68 | |
67 | While most of this works on all types of file descriptors (for example |
69 | While most of this works on all types of file descriptors (for |
68 | sockets), using these functions on file descriptors that support |
70 | example sockets), using these functions on file descriptors that |
69 | nonblocking operation (again, sockets, pipes etc.) is very inefficient or |
71 | support nonblocking operation (again, sockets, pipes etc.) is very |
70 | might not work (aio_read fails on sockets/pipes/fifos). Use an event loop |
72 | inefficient. Use an event loop for that (such as the L<Event|Event> |
71 | for that (such as the L<Event|Event> module): IO::AIO will naturally fit |
73 | module): IO::AIO will naturally fit into such an event loop itself. |
72 | into such an event loop itself. |
|
|
73 | |
74 | |
74 | In this version, a number of threads are started that execute your |
75 | In this version, a number of threads are started that execute your |
75 | requests and signal their completion. You don't need thread support |
76 | requests and signal their completion. You don't need thread support |
76 | in perl, and the threads created by this module will not be visible |
77 | in perl, and the threads created by this module will not be visible |
77 | to perl. In the future, this module might make use of the native aio |
78 | to perl. In the future, this module might make use of the native aio |
… | |
… | |
79 | not well-supported or restricted (GNU/Linux doesn't allow them on normal |
80 | not well-supported or restricted (GNU/Linux doesn't allow them on normal |
80 | files currently, for example), and they would only support aio_read and |
81 | files currently, for example), and they would only support aio_read and |
81 | aio_write, so the remaining functionality would have to be implemented |
82 | aio_write, so the remaining functionality would have to be implemented |
82 | using threads anyway. |
83 | using threads anyway. |
83 | |
84 | |
84 | Although the module will work with in the presence of other (Perl-) |
85 | Although the module will work in the presence of other (Perl-) threads, |
85 | threads, it is currently not reentrant in any way, so use appropriate |
86 | it is currently not reentrant in any way, so use appropriate locking |
86 | locking yourself, always call C<poll_cb> from within the same thread, or |
87 | yourself, always call C<poll_cb> from within the same thread, or never |
87 | never call C<poll_cb> (or other C<aio_> functions) recursively. |
88 | call C<poll_cb> (or other C<aio_> functions) recursively. |
88 | |
89 | |
89 | =head2 EXAMPLE |
90 | =head2 EXAMPLE |
90 | |
91 | |
91 | This is a simple example that uses the Event module and loads |
92 | This is a simple example that uses the Event module and loads |
92 | F</etc/passwd> asynchronously: |
93 | F</etc/passwd> asynchronously: |
… | |
… | |
184 | |
185 | |
185 | =cut |
186 | =cut |
186 | |
187 | |
187 | package IO::AIO; |
188 | package IO::AIO; |
188 | |
189 | |
|
|
190 | use Carp (); |
|
|
191 | |
189 | no warnings; |
192 | no warnings; |
190 | use strict 'vars'; |
193 | use strict 'vars'; |
191 | |
194 | |
192 | use base 'Exporter'; |
195 | use base 'Exporter'; |
193 | |
196 | |
194 | BEGIN { |
197 | BEGIN { |
195 | our $VERSION = '2.4'; |
198 | our $VERSION = '3.19'; |
196 | |
199 | |
197 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat |
200 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close |
198 | aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink |
201 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir |
199 | aio_readlink aio_fsync aio_fdatasync aio_readahead aio_rename aio_link |
202 | aio_scandir aio_symlink aio_readlink aio_sync aio_fsync |
|
|
203 | aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead |
|
|
204 | aio_rename aio_link aio_move aio_copy aio_group |
200 | aio_move aio_copy aio_group aio_nop aio_mknod aio_load aio_rmtree aio_mkdir |
205 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
201 | aio_chown aio_chmod aio_utime); |
206 | aio_chmod aio_utime aio_truncate); |
|
|
207 | |
202 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block)); |
208 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
203 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
209 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
204 | min_parallel max_parallel max_idle |
210 | min_parallel max_parallel max_idle |
205 | nreqs nready npending nthreads |
211 | nreqs nready npending nthreads |
206 | max_poll_time max_poll_reqs); |
212 | max_poll_time max_poll_reqs); |
|
|
213 | |
|
|
214 | push @AIO_REQ, qw(aio_busy); # not exported |
207 | |
215 | |
208 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
216 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
209 | |
217 | |
210 | require XSLoader; |
218 | require XSLoader; |
211 | XSLoader::load ("IO::AIO", $VERSION); |
219 | XSLoader::load ("IO::AIO", $VERSION); |
… | |
… | |
218 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
226 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
219 | with the same name (sans C<aio_>). The arguments are similar or identical, |
227 | with the same name (sans C<aio_>). The arguments are similar or identical, |
220 | and they all accept an additional (and optional) C<$callback> argument |
228 | and they all accept an additional (and optional) C<$callback> argument |
221 | which must be a code reference. This code reference will get called with |
229 | which must be a code reference. This code reference will get called with |
222 | the syscall return code (e.g. most syscalls return C<-1> on error, unlike |
230 | the syscall return code (e.g. most syscalls return C<-1> on error, unlike |
223 | perl, which usually delivers "false") as it's sole argument when the given |
231 | perl, which usually delivers "false") as its sole argument after the given |
224 | syscall has been executed asynchronously. |
232 | syscall has been executed asynchronously. |
225 | |
233 | |
226 | All functions expecting a filehandle keep a copy of the filehandle |
234 | All functions expecting a filehandle keep a copy of the filehandle |
227 | internally until the request has finished. |
235 | internally until the request has finished. |
228 | |
236 | |
… | |
… | |
242 | your pathnames to the locale (or other) encoding in effect in the user |
250 | your pathnames to the locale (or other) encoding in effect in the user |
243 | environment, d) use Glib::filename_from_unicode on unicode filenames or e) |
251 | environment, d) use Glib::filename_from_unicode on unicode filenames or e) |
244 | use something else to ensure your scalar has the correct contents. |
252 | use something else to ensure your scalar has the correct contents. |
245 | |
253 | |
246 | This works, btw. independent of the internal UTF-8 bit, which IO::AIO |
254 | This works, btw. independent of the internal UTF-8 bit, which IO::AIO |
247 | handles correctly wether it is set or not. |
255 | handles correctly whether it is set or not. |
248 | |
256 | |
249 | =over 4 |
257 | =over 4 |
250 | |
258 | |
251 | =item $prev_pri = aioreq_pri [$pri] |
259 | =item $prev_pri = aioreq_pri [$pri] |
252 | |
260 | |
… | |
… | |
312 | |
320 | |
313 | |
321 | |
314 | =item aio_close $fh, $callback->($status) |
322 | =item aio_close $fh, $callback->($status) |
315 | |
323 | |
316 | Asynchronously close a file and call the callback with the result |
324 | Asynchronously close a file and call the callback with the result |
317 | code. I<WARNING:> although accepted, you should not pass in a perl |
325 | code. |
318 | filehandle here, as perl will likely close the file descriptor another |
|
|
319 | time when the filehandle is destroyed. Normally, you can safely call perls |
|
|
320 | C<close> or just let filehandles go out of scope. |
|
|
321 | |
326 | |
322 | This is supposed to be a bug in the API, so that might change. It's |
327 | Unfortunately, you can't do this to perl. Perl I<insists> very strongly on |
323 | therefore best to avoid this function. |
328 | closing the file descriptor associated with the filehandle itself. |
324 | |
329 | |
|
|
330 | Therefore, C<aio_close> will not close the filehandle - instead it will |
|
|
331 | use dup2 to overwrite the file descriptor with the write-end of a pipe |
|
|
332 | (the pipe fd will be created on demand and will be cached). |
|
|
333 | |
|
|
334 | Or in other words: the file descriptor will be closed, but it will not be |
|
|
335 | free for reuse until the perl filehandle is closed. |
|
|
336 | |
|
|
337 | =cut |
325 | |
338 | |
326 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
339 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
327 | |
340 | |
328 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
341 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
329 | |
342 | |
330 | Reads or writes C<length> bytes from the specified C<fh> and C<offset> |
343 | Reads or writes C<$length> bytes from or to the specified C<$fh> and |
331 | into the scalar given by C<data> and offset C<dataoffset> and calls the |
344 | C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> |
332 | callback without the actual number of bytes read (or -1 on error, just |
345 | and calls the callback without the actual number of bytes read (or -1 on |
333 | like the syscall). |
346 | error, just like the syscall). |
|
|
347 | |
|
|
348 | C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to |
|
|
349 | offset plus the actual number of bytes read. |
|
|
350 | |
|
|
351 | If C<$offset> is undefined, then the current file descriptor offset will |
|
|
352 | be used (and updated), otherwise the file descriptor offset will not be |
|
|
353 | changed by these calls. |
|
|
354 | |
|
|
355 | If C<$length> is undefined in C<aio_write>, use the remaining length of |
|
|
356 | C<$data>. |
|
|
357 | |
|
|
358 | If C<$dataoffset> is less than zero, it will be counted from the end of |
|
|
359 | C<$data>. |
334 | |
360 | |
335 | The C<$data> scalar I<MUST NOT> be modified in any way while the request |
361 | The C<$data> scalar I<MUST NOT> be modified in any way while the request |
336 | is outstanding. Modifying it can result in segfaults or WW3 (if the |
362 | is outstanding. Modifying it can result in segfaults or World War III (if |
337 | necessary/optional hardware is installed). |
363 | the necessary/optional hardware is installed). |
338 | |
364 | |
339 | Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at |
365 | Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at |
340 | offset C<0> within the scalar: |
366 | offset C<0> within the scalar: |
341 | |
367 | |
342 | aio_read $fh, 7, 15, $buffer, 0, sub { |
368 | aio_read $fh, 7, 15, $buffer, 0, sub { |
… | |
… | |
436 | aio_chown "path", 0, -1; |
462 | aio_chown "path", 0, -1; |
437 | # same as above: |
463 | # same as above: |
438 | aio_chown "path", 0, undef; |
464 | aio_chown "path", 0, undef; |
439 | |
465 | |
440 | |
466 | |
|
|
467 | =item aio_truncate $fh_or_path, $offset, $callback->($status) |
|
|
468 | |
|
|
469 | Works like truncate(2) or ftruncate(2). |
|
|
470 | |
|
|
471 | |
441 | =item aio_chmod $fh_or_path, $mode, $callback->($status) |
472 | =item aio_chmod $fh_or_path, $mode, $callback->($status) |
442 | |
473 | |
443 | Works like perl's C<chmod> function. |
474 | Works like perl's C<chmod> function. |
444 | |
475 | |
445 | |
476 | |
… | |
… | |
514 | memory. Status is the same as with aio_read. |
545 | memory. Status is the same as with aio_read. |
515 | |
546 | |
516 | =cut |
547 | =cut |
517 | |
548 | |
518 | sub aio_load($$;$) { |
549 | sub aio_load($$;$) { |
519 | aio_block { |
|
|
520 | my ($path, undef, $cb) = @_; |
550 | my ($path, undef, $cb) = @_; |
521 | my $data = \$_[1]; |
551 | my $data = \$_[1]; |
522 | |
552 | |
523 | my $pri = aioreq_pri; |
553 | my $pri = aioreq_pri; |
524 | my $grp = aio_group $cb; |
554 | my $grp = aio_group $cb; |
|
|
555 | |
|
|
556 | aioreq_pri $pri; |
|
|
557 | add $grp aio_open $path, O_RDONLY, 0, sub { |
|
|
558 | my $fh = shift |
|
|
559 | or return $grp->result (-1); |
525 | |
560 | |
526 | aioreq_pri $pri; |
561 | aioreq_pri $pri; |
527 | add $grp aio_open $path, O_RDONLY, 0, sub { |
|
|
528 | my $fh = shift |
|
|
529 | or return $grp->result (-1); |
|
|
530 | |
|
|
531 | aioreq_pri $pri; |
|
|
532 | add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub { |
562 | add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub { |
533 | $grp->result ($_[0]); |
563 | $grp->result ($_[0]); |
534 | }; |
|
|
535 | }; |
564 | }; |
536 | |
|
|
537 | $grp |
|
|
538 | } |
565 | }; |
|
|
566 | |
|
|
567 | $grp |
539 | } |
568 | } |
540 | |
569 | |
541 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
570 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
542 | |
571 | |
543 | Try to copy the I<file> (directories not supported as either source or |
572 | Try to copy the I<file> (directories not supported as either source or |
544 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
573 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
545 | the C<0> (error) or C<-1> ok. |
574 | the C<0> (error) or C<-1> ok. |
546 | |
575 | |
547 | This is a composite request that it creates the destination file with |
576 | This is a composite request that creates the destination file with |
548 | mode 0200 and copies the contents of the source file into it using |
577 | mode 0200 and copies the contents of the source file into it using |
549 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
578 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
550 | uid/gid, in that order. |
579 | uid/gid, in that order. |
551 | |
580 | |
552 | If an error occurs, the partial destination file will be unlinked, if |
581 | If an error occurs, the partial destination file will be unlinked, if |
… | |
… | |
554 | errors are being ignored. |
583 | errors are being ignored. |
555 | |
584 | |
556 | =cut |
585 | =cut |
557 | |
586 | |
558 | sub aio_copy($$;$) { |
587 | sub aio_copy($$;$) { |
559 | aio_block { |
|
|
560 | my ($src, $dst, $cb) = @_; |
588 | my ($src, $dst, $cb) = @_; |
561 | |
589 | |
562 | my $pri = aioreq_pri; |
590 | my $pri = aioreq_pri; |
563 | my $grp = aio_group $cb; |
591 | my $grp = aio_group $cb; |
564 | |
592 | |
565 | aioreq_pri $pri; |
593 | aioreq_pri $pri; |
566 | add $grp aio_open $src, O_RDONLY, 0, sub { |
594 | add $grp aio_open $src, O_RDONLY, 0, sub { |
567 | if (my $src_fh = $_[0]) { |
595 | if (my $src_fh = $_[0]) { |
568 | my @stat = stat $src_fh; |
596 | my @stat = stat $src_fh; |
569 | |
597 | |
570 | aioreq_pri $pri; |
598 | aioreq_pri $pri; |
571 | add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { |
599 | add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { |
572 | if (my $dst_fh = $_[0]) { |
600 | if (my $dst_fh = $_[0]) { |
573 | aioreq_pri $pri; |
601 | aioreq_pri $pri; |
574 | add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { |
602 | add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { |
575 | if ($_[0] == $stat[7]) { |
603 | if ($_[0] == $stat[7]) { |
576 | $grp->result (0); |
604 | $grp->result (0); |
577 | close $src_fh; |
605 | close $src_fh; |
578 | |
606 | |
579 | # those should not normally block. should. should. |
607 | # those should not normally block. should. should. |
580 | utime $stat[8], $stat[9], $dst; |
608 | utime $stat[8], $stat[9], $dst; |
581 | chmod $stat[2] & 07777, $dst_fh; |
609 | chmod $stat[2] & 07777, $dst_fh; |
582 | chown $stat[4], $stat[5], $dst_fh; |
610 | chown $stat[4], $stat[5], $dst_fh; |
|
|
611 | |
|
|
612 | aioreq_pri $pri; |
583 | close $dst_fh; |
613 | add $grp aio_close $dst_fh; |
584 | } else { |
614 | } else { |
585 | $grp->result (-1); |
615 | $grp->result (-1); |
586 | close $src_fh; |
616 | close $src_fh; |
587 | close $dst_fh; |
617 | close $dst_fh; |
588 | |
618 | |
589 | aioreq $pri; |
619 | aioreq $pri; |
590 | add $grp aio_unlink $dst; |
620 | add $grp aio_unlink $dst; |
591 | } |
|
|
592 | }; |
621 | } |
593 | } else { |
|
|
594 | $grp->result (-1); |
|
|
595 | } |
622 | }; |
|
|
623 | } else { |
|
|
624 | $grp->result (-1); |
596 | }, |
625 | } |
597 | |
|
|
598 | } else { |
|
|
599 | $grp->result (-1); |
|
|
600 | } |
626 | }, |
|
|
627 | |
|
|
628 | } else { |
|
|
629 | $grp->result (-1); |
601 | }; |
630 | } |
602 | |
|
|
603 | $grp |
|
|
604 | } |
631 | }; |
|
|
632 | |
|
|
633 | $grp |
605 | } |
634 | } |
606 | |
635 | |
607 | =item aio_move $srcpath, $dstpath, $callback->($status) |
636 | =item aio_move $srcpath, $dstpath, $callback->($status) |
608 | |
637 | |
609 | Try to move the I<file> (directories not supported as either source or |
638 | Try to move the I<file> (directories not supported as either source or |
610 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
639 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
611 | the C<0> (error) or C<-1> ok. |
640 | the C<0> (error) or C<-1> ok. |
612 | |
641 | |
613 | This is a composite request that tries to rename(2) the file first. If |
642 | This is a composite request that tries to rename(2) the file first; if |
614 | rename files with C<EXDEV>, it copies the file with C<aio_copy> and, if |
643 | rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if |
615 | that is successful, unlinking the C<$srcpath>. |
644 | that is successful, unlinks the C<$srcpath>. |
616 | |
645 | |
617 | =cut |
646 | =cut |
618 | |
647 | |
619 | sub aio_move($$;$) { |
648 | sub aio_move($$;$) { |
620 | aio_block { |
|
|
621 | my ($src, $dst, $cb) = @_; |
649 | my ($src, $dst, $cb) = @_; |
622 | |
650 | |
623 | my $pri = aioreq_pri; |
651 | my $pri = aioreq_pri; |
624 | my $grp = aio_group $cb; |
652 | my $grp = aio_group $cb; |
625 | |
653 | |
626 | aioreq_pri $pri; |
654 | aioreq_pri $pri; |
627 | add $grp aio_rename $src, $dst, sub { |
655 | add $grp aio_rename $src, $dst, sub { |
628 | if ($_[0] && $! == EXDEV) { |
656 | if ($_[0] && $! == EXDEV) { |
629 | aioreq_pri $pri; |
657 | aioreq_pri $pri; |
630 | add $grp aio_copy $src, $dst, sub { |
658 | add $grp aio_copy $src, $dst, sub { |
631 | $grp->result ($_[0]); |
|
|
632 | |
|
|
633 | if (!$_[0]) { |
|
|
634 | aioreq_pri $pri; |
|
|
635 | add $grp aio_unlink $src; |
|
|
636 | } |
|
|
637 | }; |
|
|
638 | } else { |
|
|
639 | $grp->result ($_[0]); |
659 | $grp->result ($_[0]); |
|
|
660 | |
|
|
661 | if (!$_[0]) { |
|
|
662 | aioreq_pri $pri; |
|
|
663 | add $grp aio_unlink $src; |
|
|
664 | } |
640 | } |
665 | }; |
|
|
666 | } else { |
|
|
667 | $grp->result ($_[0]); |
641 | }; |
668 | } |
642 | |
|
|
643 | $grp |
|
|
644 | } |
669 | }; |
|
|
670 | |
|
|
671 | $grp |
645 | } |
672 | } |
646 | |
673 | |
647 | =item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
674 | =item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
648 | |
675 | |
649 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
676 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
… | |
… | |
697 | directory counting heuristic. |
724 | directory counting heuristic. |
698 | |
725 | |
699 | =cut |
726 | =cut |
700 | |
727 | |
701 | sub aio_scandir($$;$) { |
728 | sub aio_scandir($$;$) { |
702 | aio_block { |
|
|
703 | my ($path, $maxreq, $cb) = @_; |
729 | my ($path, $maxreq, $cb) = @_; |
704 | |
730 | |
705 | my $pri = aioreq_pri; |
731 | my $pri = aioreq_pri; |
706 | |
732 | |
707 | my $grp = aio_group $cb; |
733 | my $grp = aio_group $cb; |
708 | |
734 | |
709 | $maxreq = 4 if $maxreq <= 0; |
735 | $maxreq = 4 if $maxreq <= 0; |
710 | |
736 | |
711 | # stat once |
737 | # stat once |
|
|
738 | aioreq_pri $pri; |
|
|
739 | add $grp aio_stat $path, sub { |
|
|
740 | return $grp->result () if $_[0]; |
|
|
741 | my $now = time; |
|
|
742 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
|
|
743 | |
|
|
744 | # read the directory entries |
712 | aioreq_pri $pri; |
745 | aioreq_pri $pri; |
713 | add $grp aio_stat $path, sub { |
746 | add $grp aio_readdir $path, sub { |
|
|
747 | my $entries = shift |
714 | return $grp->result () if $_[0]; |
748 | or return $grp->result (); |
715 | my $now = time; |
|
|
716 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
|
|
717 | |
749 | |
718 | # read the directory entries |
750 | # stat the dir another time |
719 | aioreq_pri $pri; |
751 | aioreq_pri $pri; |
720 | add $grp aio_readdir $path, sub { |
|
|
721 | my $entries = shift |
|
|
722 | or return $grp->result (); |
|
|
723 | |
|
|
724 | # stat the dir another time |
|
|
725 | aioreq_pri $pri; |
|
|
726 | add $grp aio_stat $path, sub { |
752 | add $grp aio_stat $path, sub { |
727 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
753 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
728 | |
754 | |
729 | my $ndirs; |
755 | my $ndirs; |
730 | |
756 | |
731 | # take the slow route if anything looks fishy |
757 | # take the slow route if anything looks fishy |
732 | if ($hash1 ne $hash2 or (stat _)[9] == $now) { |
758 | if ($hash1 ne $hash2 or (stat _)[9] == $now) { |
733 | $ndirs = -1; |
759 | $ndirs = -1; |
734 | } else { |
760 | } else { |
735 | # if nlink == 2, we are finished |
761 | # if nlink == 2, we are finished |
736 | # on non-posix-fs's, we rely on nlink < 2 |
762 | # on non-posix-fs's, we rely on nlink < 2 |
737 | $ndirs = (stat _)[3] - 2 |
763 | $ndirs = (stat _)[3] - 2 |
738 | or return $grp->result ([], $entries); |
764 | or return $grp->result ([], $entries); |
739 | } |
765 | } |
740 | |
766 | |
741 | # sort into likely dirs and likely nondirs |
767 | # sort into likely dirs and likely nondirs |
742 | # dirs == files without ".", short entries first |
768 | # dirs == files without ".", short entries first |
743 | $entries = [map $_->[0], |
769 | $entries = [map $_->[0], |
744 | sort { $b->[1] cmp $a->[1] } |
770 | sort { $b->[1] cmp $a->[1] } |
745 | map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], |
771 | map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], |
746 | @$entries]; |
772 | @$entries]; |
747 | |
773 | |
748 | my (@dirs, @nondirs); |
774 | my (@dirs, @nondirs); |
749 | |
775 | |
750 | my $statgrp = add $grp aio_group sub { |
776 | my $statgrp = add $grp aio_group sub { |
751 | $grp->result (\@dirs, \@nondirs); |
777 | $grp->result (\@dirs, \@nondirs); |
752 | }; |
778 | }; |
753 | |
779 | |
754 | limit $statgrp $maxreq; |
780 | limit $statgrp $maxreq; |
755 | feed $statgrp sub { |
781 | feed $statgrp sub { |
756 | return unless @$entries; |
782 | return unless @$entries; |
757 | my $entry = pop @$entries; |
783 | my $entry = pop @$entries; |
758 | |
784 | |
759 | aioreq_pri $pri; |
785 | aioreq_pri $pri; |
760 | add $statgrp aio_stat "$path/$entry/.", sub { |
786 | add $statgrp aio_stat "$path/$entry/.", sub { |
761 | if ($_[0] < 0) { |
787 | if ($_[0] < 0) { |
762 | push @nondirs, $entry; |
788 | push @nondirs, $entry; |
763 | } else { |
789 | } else { |
764 | # need to check for real directory |
790 | # need to check for real directory |
765 | aioreq_pri $pri; |
791 | aioreq_pri $pri; |
766 | add $statgrp aio_lstat "$path/$entry", sub { |
792 | add $statgrp aio_lstat "$path/$entry", sub { |
767 | if (-d _) { |
793 | if (-d _) { |
768 | push @dirs, $entry; |
794 | push @dirs, $entry; |
769 | |
795 | |
770 | unless (--$ndirs) { |
796 | unless (--$ndirs) { |
771 | push @nondirs, @$entries; |
797 | push @nondirs, @$entries; |
772 | feed $statgrp; |
798 | feed $statgrp; |
773 | } |
|
|
774 | } else { |
|
|
775 | push @nondirs, $entry; |
|
|
776 | } |
799 | } |
|
|
800 | } else { |
|
|
801 | push @nondirs, $entry; |
777 | } |
802 | } |
778 | } |
803 | } |
779 | }; |
804 | } |
780 | }; |
805 | }; |
781 | }; |
806 | }; |
782 | }; |
807 | }; |
783 | }; |
808 | }; |
784 | |
|
|
785 | $grp |
|
|
786 | } |
809 | }; |
|
|
810 | |
|
|
811 | $grp |
787 | } |
812 | } |
788 | |
813 | |
789 | =item aio_rmtree $path, $callback->($status) |
814 | =item aio_rmtree $path, $callback->($status) |
790 | |
815 | |
791 | Delete a directory tree starting (and including) C<$path>, return the |
816 | Delete a directory tree starting (and including) C<$path>, return the |
… | |
… | |
795 | |
820 | |
796 | =cut |
821 | =cut |
797 | |
822 | |
798 | sub aio_rmtree; |
823 | sub aio_rmtree; |
799 | sub aio_rmtree($;$) { |
824 | sub aio_rmtree($;$) { |
800 | aio_block { |
|
|
801 | my ($path, $cb) = @_; |
825 | my ($path, $cb) = @_; |
802 | |
826 | |
803 | my $pri = aioreq_pri; |
827 | my $pri = aioreq_pri; |
804 | my $grp = aio_group $cb; |
828 | my $grp = aio_group $cb; |
805 | |
829 | |
806 | aioreq_pri $pri; |
830 | aioreq_pri $pri; |
807 | add $grp aio_scandir $path, 0, sub { |
831 | add $grp aio_scandir $path, 0, sub { |
808 | my ($dirs, $nondirs) = @_; |
832 | my ($dirs, $nondirs) = @_; |
809 | |
833 | |
810 | my $dirgrp = aio_group sub { |
834 | my $dirgrp = aio_group sub { |
811 | add $grp aio_rmdir $path, sub { |
835 | add $grp aio_rmdir $path, sub { |
812 | $grp->result ($_[0]); |
836 | $grp->result ($_[0]); |
813 | }; |
|
|
814 | }; |
837 | }; |
815 | |
|
|
816 | (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs; |
|
|
817 | (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs; |
|
|
818 | |
|
|
819 | add $grp $dirgrp; |
|
|
820 | }; |
838 | }; |
821 | |
839 | |
822 | $grp |
840 | (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs; |
|
|
841 | (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs; |
|
|
842 | |
|
|
843 | add $grp $dirgrp; |
823 | } |
844 | }; |
|
|
845 | |
|
|
846 | $grp |
824 | } |
847 | } |
|
|
848 | |
|
|
849 | =item aio_sync $callback->($status) |
|
|
850 | |
|
|
851 | Asynchronously call sync and call the callback when finished. |
825 | |
852 | |
826 | =item aio_fsync $fh, $callback->($status) |
853 | =item aio_fsync $fh, $callback->($status) |
827 | |
854 | |
828 | Asynchronously call fsync on the given filehandle and call the callback |
855 | Asynchronously call fsync on the given filehandle and call the callback |
829 | with the fsync result code. |
856 | with the fsync result code. |
… | |
… | |
833 | Asynchronously call fdatasync on the given filehandle and call the |
860 | Asynchronously call fdatasync on the given filehandle and call the |
834 | callback with the fdatasync result code. |
861 | callback with the fdatasync result code. |
835 | |
862 | |
836 | If this call isn't available because your OS lacks it or it couldn't be |
863 | If this call isn't available because your OS lacks it or it couldn't be |
837 | detected, it will be emulated by calling C<fsync> instead. |
864 | detected, it will be emulated by calling C<fsync> instead. |
|
|
865 | |
|
|
866 | =item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
|
|
867 | |
|
|
868 | Sync the data portion of the file specified by C<$offset> and C<$length> |
|
|
869 | to disk (but NOT the metadata), by calling the Linux-specific |
|
|
870 | sync_file_range call. If sync_file_range is not available or it returns |
|
|
871 | ENOSYS, then fdatasync or fsync is being substituted. |
|
|
872 | |
|
|
873 | C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>, |
|
|
874 | C<IO::AIO::SYNC_FILE_RANGE_WRITE> and |
|
|
875 | C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range |
|
|
876 | manpage for details. |
|
|
877 | |
|
|
878 | =item aio_pathsync $path, $callback->($status) |
|
|
879 | |
|
|
880 | This request tries to open, fsync and close the given path. This is a |
|
|
881 | composite request intended to sync directories after directory operations |
|
|
882 | (E.g. rename). This might not work on all operating systems or have any |
|
|
883 | specific effect, but usually it makes sure that directory changes get |
|
|
884 | written to disc. It works for anything that can be opened for read-only, |
|
|
885 | not just directories. |
|
|
886 | |
|
|
887 | Passes C<0> when everything went ok, and C<-1> on error. |
|
|
888 | |
|
|
889 | =cut |
|
|
890 | |
|
|
891 | sub aio_pathsync($;$) { |
|
|
892 | my ($path, $cb) = @_; |
|
|
893 | |
|
|
894 | my $pri = aioreq_pri; |
|
|
895 | my $grp = aio_group $cb; |
|
|
896 | |
|
|
897 | aioreq_pri $pri; |
|
|
898 | add $grp aio_open $path, O_RDONLY, 0, sub { |
|
|
899 | my ($fh) = @_; |
|
|
900 | if ($fh) { |
|
|
901 | aioreq_pri $pri; |
|
|
902 | add $grp aio_fsync $fh, sub { |
|
|
903 | $grp->result ($_[0]); |
|
|
904 | |
|
|
905 | aioreq_pri $pri; |
|
|
906 | add $grp aio_close $fh; |
|
|
907 | }; |
|
|
908 | } else { |
|
|
909 | $grp->result (-1); |
|
|
910 | } |
|
|
911 | }; |
|
|
912 | |
|
|
913 | $grp |
|
|
914 | } |
838 | |
915 | |
839 | =item aio_group $callback->(...) |
916 | =item aio_group $callback->(...) |
840 | |
917 | |
841 | This is a very special aio request: Instead of doing something, it is a |
918 | This is a very special aio request: Instead of doing something, it is a |
842 | container for other aio requests, which is useful if you want to bundle |
919 | container for other aio requests, which is useful if you want to bundle |
… | |
… | |
954 | Their lifetime, simplified, looks like this: when they are empty, they |
1031 | Their lifetime, simplified, looks like this: when they are empty, they |
955 | will finish very quickly. If they contain only requests that are in the |
1032 | will finish very quickly. If they contain only requests that are in the |
956 | C<done> state, they will also finish. Otherwise they will continue to |
1033 | C<done> state, they will also finish. Otherwise they will continue to |
957 | exist. |
1034 | exist. |
958 | |
1035 | |
959 | That means after creating a group you have some time to add requests. And |
1036 | That means after creating a group you have some time to add requests |
960 | in the callbacks of those requests, you can add further requests to the |
1037 | (precisely before the callback has been invoked, which is only done within |
961 | group. And only when all those requests have finished will the the group |
1038 | the C<poll_cb>). And in the callbacks of those requests, you can add |
962 | itself finish. |
1039 | further requests to the group. And only when all those requests have |
|
|
1040 | finished will the the group itself finish. |
963 | |
1041 | |
964 | =over 4 |
1042 | =over 4 |
965 | |
1043 | |
966 | =item add $grp ... |
1044 | =item add $grp ... |
967 | |
1045 | |
… | |
… | |
979 | itself. Useful when you queued a lot of events but got a result early. |
1057 | itself. Useful when you queued a lot of events but got a result early. |
980 | |
1058 | |
981 | =item $grp->result (...) |
1059 | =item $grp->result (...) |
982 | |
1060 | |
983 | Set the result value(s) that will be passed to the group callback when all |
1061 | Set the result value(s) that will be passed to the group callback when all |
984 | subrequests have finished and set thre groups errno to the current value |
1062 | subrequests have finished and set the groups errno to the current value |
985 | of errno (just like calling C<errno> without an error number). By default, |
1063 | of errno (just like calling C<errno> without an error number). By default, |
986 | no argument will be passed and errno is zero. |
1064 | no argument will be passed and errno is zero. |
987 | |
1065 | |
988 | =item $grp->errno ([$errno]) |
1066 | =item $grp->errno ([$errno]) |
989 | |
1067 | |
… | |
… | |
1000 | =item feed $grp $callback->($grp) |
1078 | =item feed $grp $callback->($grp) |
1001 | |
1079 | |
1002 | Sets a feeder/generator on this group: every group can have an attached |
1080 | Sets a feeder/generator on this group: every group can have an attached |
1003 | generator that generates requests if idle. The idea behind this is that, |
1081 | generator that generates requests if idle. The idea behind this is that, |
1004 | although you could just queue as many requests as you want in a group, |
1082 | although you could just queue as many requests as you want in a group, |
1005 | this might starve other requests for a potentially long time. For |
1083 | this might starve other requests for a potentially long time. For example, |
1006 | example, C<aio_scandir> might generate hundreds of thousands C<aio_stat> |
1084 | C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests, |
1007 | requests, delaying any later requests for a long time. |
1085 | delaying any later requests for a long time. |
1008 | |
1086 | |
1009 | To avoid this, and allow incremental generation of requests, you can |
1087 | To avoid this, and allow incremental generation of requests, you can |
1010 | instead a group and set a feeder on it that generates those requests. The |
1088 | instead a group and set a feeder on it that generates those requests. The |
1011 | feed callback will be called whenever there are few enough (see C<limit>, |
1089 | feed callback will be called whenever there are few enough (see C<limit>, |
1012 | below) requests active in the group itself and is expected to queue more |
1090 | below) requests active in the group itself and is expected to queue more |
… | |
… | |
1016 | not impose any limits). |
1094 | not impose any limits). |
1017 | |
1095 | |
1018 | If the feed does not queue more requests when called, it will be |
1096 | If the feed does not queue more requests when called, it will be |
1019 | automatically removed from the group. |
1097 | automatically removed from the group. |
1020 | |
1098 | |
1021 | If the feed limit is C<0>, it will be set to C<2> automatically. |
1099 | If the feed limit is C<0> when this method is called, it will be set to |
|
|
1100 | C<2> automatically. |
1022 | |
1101 | |
1023 | Example: |
1102 | Example: |
1024 | |
1103 | |
1025 | # stat all files in @files, but only ever use four aio requests concurrently: |
1104 | # stat all files in @files, but only ever use four aio requests concurrently: |
1026 | |
1105 | |
… | |
… | |
1038 | Sets the feeder limit for the group: The feeder will be called whenever |
1117 | Sets the feeder limit for the group: The feeder will be called whenever |
1039 | the group contains less than this many requests. |
1118 | the group contains less than this many requests. |
1040 | |
1119 | |
1041 | Setting the limit to C<0> will pause the feeding process. |
1120 | Setting the limit to C<0> will pause the feeding process. |
1042 | |
1121 | |
|
|
1122 | The default value for the limit is C<0>, but note that setting a feeder |
|
|
1123 | automatically bumps it up to C<2>. |
|
|
1124 | |
1043 | =back |
1125 | =back |
1044 | |
1126 | |
1045 | =head2 SUPPORT FUNCTIONS |
1127 | =head2 SUPPORT FUNCTIONS |
1046 | |
1128 | |
1047 | =head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION |
1129 | =head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION |
… | |
… | |
1058 | See C<poll_cb> for an example. |
1140 | See C<poll_cb> for an example. |
1059 | |
1141 | |
1060 | =item IO::AIO::poll_cb |
1142 | =item IO::AIO::poll_cb |
1061 | |
1143 | |
1062 | Process some outstanding events on the result pipe. You have to call this |
1144 | Process some outstanding events on the result pipe. You have to call this |
1063 | regularly. Returns the number of events processed. Returns immediately |
1145 | regularly. Returns C<0> if all events could be processed, or C<-1> if it |
|
|
1146 | returned earlier for whatever reason. Returns immediately when no events |
1064 | when no events are outstanding. The amount of events processed depends on |
1147 | are outstanding. The amount of events processed depends on the settings of |
1065 | the settings of C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>. |
1148 | C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>. |
1066 | |
1149 | |
1067 | If not all requests were processed for whatever reason, the filehandle |
1150 | If not all requests were processed for whatever reason, the filehandle |
1068 | will still be ready when C<poll_cb> returns. |
1151 | will still be ready when C<poll_cb> returns, so normally you don't have to |
|
|
1152 | do anything special to have it called later. |
1069 | |
1153 | |
1070 | Example: Install an Event watcher that automatically calls |
1154 | Example: Install an Event watcher that automatically calls |
1071 | IO::AIO::poll_cb with high priority: |
1155 | IO::AIO::poll_cb with high priority: |
1072 | |
1156 | |
1073 | Event->io (fd => IO::AIO::poll_fileno, |
1157 | Event->io (fd => IO::AIO::poll_fileno, |
… | |
… | |
1187 | |
1271 | |
1188 | The default is probably ok in most situations, especially if thread |
1272 | The default is probably ok in most situations, especially if thread |
1189 | creation is fast. If thread creation is very slow on your system you might |
1273 | creation is fast. If thread creation is very slow on your system you might |
1190 | want to use larger values. |
1274 | want to use larger values. |
1191 | |
1275 | |
1192 | =item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs |
1276 | =item IO::AIO::max_outstanding $maxreqs |
1193 | |
1277 | |
1194 | This is a very bad function to use in interactive programs because it |
1278 | This is a very bad function to use in interactive programs because it |
1195 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1279 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1196 | use an C<aio_group> together with a feed callback. |
1280 | use an C<aio_group> together with a feed callback. |
1197 | |
1281 | |
1198 | Sets the maximum number of outstanding requests to C<$nreqs>. If you |
1282 | Sets the maximum number of outstanding requests to C<$nreqs>. If you |
1199 | to queue up more than this number of requests, the next call to the |
1283 | do queue up more than this number of requests, the next call to the |
1200 | C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>) |
1284 | C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>) |
1201 | function will block until the limit is no longer exceeded. |
1285 | function will block until the limit is no longer exceeded. |
1202 | |
1286 | |
1203 | The default value is very large, so there is no practical limit on the |
1287 | The default value is very large, so there is no practical limit on the |
1204 | number of outstanding requests. |
1288 | number of outstanding requests. |
1205 | |
1289 | |
1206 | You can still queue as many requests as you want. Therefore, |
1290 | You can still queue as many requests as you want. Therefore, |
1207 | C<max_oustsanding> is mainly useful in simple scripts (with low values) or |
1291 | C<max_outstanding> is mainly useful in simple scripts (with low values) or |
1208 | as a stop gap to shield against fatal memory overflow (with large values). |
1292 | as a stop gap to shield against fatal memory overflow (with large values). |
1209 | |
1293 | |
1210 | =back |
1294 | =back |
1211 | |
1295 | |
1212 | =head3 STATISTICAL INFORMATION |
1296 | =head3 STATISTICAL INFORMATION |
… | |
… | |
1234 | but not yet processed by poll_cb). |
1318 | but not yet processed by poll_cb). |
1235 | |
1319 | |
1236 | =back |
1320 | =back |
1237 | |
1321 | |
1238 | =cut |
1322 | =cut |
1239 | |
|
|
1240 | # support function to convert a fd into a perl filehandle |
|
|
1241 | sub _fd2fh { |
|
|
1242 | return undef if $_[0] < 0; |
|
|
1243 | |
|
|
1244 | # try to generate nice filehandles |
|
|
1245 | my $sym = "IO::AIO::fd#$_[0]"; |
|
|
1246 | local *$sym; |
|
|
1247 | |
|
|
1248 | open *$sym, "+<&=$_[0]" # usually works under any unix |
|
|
1249 | or open *$sym, "<&=$_[0]" # cygwin needs this |
|
|
1250 | or open *$sym, ">&=$_[0]" # or this |
|
|
1251 | or return undef; |
|
|
1252 | |
|
|
1253 | *$sym |
|
|
1254 | } |
|
|
1255 | |
1323 | |
1256 | min_parallel 8; |
1324 | min_parallel 8; |
1257 | |
1325 | |
1258 | END { flush } |
1326 | END { flush } |
1259 | |
1327 | |
… | |
… | |
1283 | bytes of memory. In addition, stat requests need a stat buffer (possibly |
1351 | bytes of memory. In addition, stat requests need a stat buffer (possibly |
1284 | a few hundred bytes), readdir requires a result buffer and so on. Perl |
1352 | a few hundred bytes), readdir requires a result buffer and so on. Perl |
1285 | scalars and other data passed into aio requests will also be locked and |
1353 | scalars and other data passed into aio requests will also be locked and |
1286 | will consume memory till the request has entered the done state. |
1354 | will consume memory till the request has entered the done state. |
1287 | |
1355 | |
1288 | This is now awfully much, so queuing lots of requests is not usually a |
1356 | This is not awfully much, so queuing lots of requests is not usually a |
1289 | problem. |
1357 | problem. |
1290 | |
1358 | |
1291 | Per-thread usage: |
1359 | Per-thread usage: |
1292 | |
1360 | |
1293 | In the execution phase, some aio requests require more memory for |
1361 | In the execution phase, some aio requests require more memory for |
… | |
… | |
1298 | |
1366 | |
1299 | Known bugs will be fixed in the next release. |
1367 | Known bugs will be fixed in the next release. |
1300 | |
1368 | |
1301 | =head1 SEE ALSO |
1369 | =head1 SEE ALSO |
1302 | |
1370 | |
1303 | L<Coro::AIO>. |
1371 | L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a |
|
|
1372 | more natural syntax. |
1304 | |
1373 | |
1305 | =head1 AUTHOR |
1374 | =head1 AUTHOR |
1306 | |
1375 | |
1307 | Marc Lehmann <schmorp@schmorp.de> |
1376 | Marc Lehmann <schmorp@schmorp.de> |
1308 | http://home.schmorp.de/ |
1377 | http://home.schmorp.de/ |