… | |
… | |
30 | |
30 | |
31 | # AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...) |
31 | # AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...) |
32 | use AnyEvent::AIO; |
32 | use AnyEvent::AIO; |
33 | |
33 | |
34 | # EV integration |
34 | # EV integration |
35 | my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; |
35 | my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; |
36 | |
36 | |
37 | # Event integration |
37 | # Event integration |
38 | Event->io (fd => IO::AIO::poll_fileno, |
38 | Event->io (fd => IO::AIO::poll_fileno, |
39 | poll => 'r', |
39 | poll => 'r', |
40 | cb => \&IO::AIO::poll_cb); |
40 | cb => \&IO::AIO::poll_cb); |
… | |
… | |
52 | \&IO::AIO::poll_cb); |
52 | \&IO::AIO::poll_cb); |
53 | |
53 | |
54 | =head1 DESCRIPTION |
54 | =head1 DESCRIPTION |
55 | |
55 | |
56 | This module implements asynchronous I/O using whatever means your |
56 | This module implements asynchronous I/O using whatever means your |
57 | operating system supports. |
57 | operating system supports. It is implemented as an interface to C<libeio> |
|
|
58 | (L<http://software.schmorp.de/pkg/libeio.html>). |
58 | |
59 | |
59 | Asynchronous means that operations that can normally block your program |
60 | Asynchronous means that operations that can normally block your program |
60 | (e.g. reading from disk) will be done asynchronously: the operation |
61 | (e.g. reading from disk) will be done asynchronously: the operation |
61 | will still block, but you can do something else in the meantime. This |
62 | will still block, but you can do something else in the meantime. This |
62 | is extremely useful for programs that need to stay interactive even |
63 | is extremely useful for programs that need to stay interactive even |
… | |
… | |
66 | on a RAID volume or over NFS when you do a number of stat operations |
67 | on a RAID volume or over NFS when you do a number of stat operations |
67 | concurrently. |
68 | concurrently. |
68 | |
69 | |
69 | While most of this works on all types of file descriptors (for |
70 | While most of this works on all types of file descriptors (for |
70 | example sockets), using these functions on file descriptors that |
71 | example sockets), using these functions on file descriptors that |
71 | support nonblocking operation (again, sockets, pipes etc.) is very |
72 | support nonblocking operation (again, sockets, pipes etc.) is |
72 | inefficient. Use an event loop for that (such as the L<Event|Event> |
73 | very inefficient. Use an event loop for that (such as the L<EV> |
73 | module): IO::AIO will naturally fit into such an event loop itself. |
74 | module): IO::AIO will naturally fit into such an event loop itself. |
74 | |
75 | |
75 | In this version, a number of threads are started that execute your |
76 | In this version, a number of threads are started that execute your |
76 | requests and signal their completion. You don't need thread support |
77 | requests and signal their completion. You don't need thread support |
77 | in perl, and the threads created by this module will not be visible |
78 | in perl, and the threads created by this module will not be visible |
… | |
… | |
87 | yourself, always call C<poll_cb> from within the same thread, or never |
88 | yourself, always call C<poll_cb> from within the same thread, or never |
88 | call C<poll_cb> (or other C<aio_> functions) recursively. |
89 | call C<poll_cb> (or other C<aio_> functions) recursively. |
89 | |
90 | |
90 | =head2 EXAMPLE |
91 | =head2 EXAMPLE |
91 | |
92 | |
92 | This is a simple example that uses the Event module and loads |
93 | This is a simple example that uses the EV module and loads |
93 | F</etc/passwd> asynchronously: |
94 | F</etc/passwd> asynchronously: |
94 | |
95 | |
95 | use Fcntl; |
96 | use Fcntl; |
96 | use Event; |
97 | use EV; |
97 | use IO::AIO; |
98 | use IO::AIO; |
98 | |
99 | |
99 | # register the IO::AIO callback with Event |
100 | # register the IO::AIO callback with EV |
100 | Event->io (fd => IO::AIO::poll_fileno, |
101 | my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; |
101 | poll => 'r', |
|
|
102 | cb => \&IO::AIO::poll_cb); |
|
|
103 | |
102 | |
104 | # queue the request to open /etc/passwd |
103 | # queue the request to open /etc/passwd |
105 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
104 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
106 | my $fh = shift |
105 | my $fh = shift |
107 | or die "error while opening: $!"; |
106 | or die "error while opening: $!"; |
… | |
… | |
119 | |
118 | |
120 | # file contents now in $contents |
119 | # file contents now in $contents |
121 | print $contents; |
120 | print $contents; |
122 | |
121 | |
123 | # exit event loop and program |
122 | # exit event loop and program |
124 | Event::unloop; |
123 | EV::unloop; |
125 | }; |
124 | }; |
126 | }; |
125 | }; |
127 | |
126 | |
128 | # possibly queue up other requests, or open GUI windows, |
127 | # possibly queue up other requests, or open GUI windows, |
129 | # check for sockets etc. etc. |
128 | # check for sockets etc. etc. |
130 | |
129 | |
131 | # process events as long as there are some: |
130 | # process events as long as there are some: |
132 | Event::loop; |
131 | EV::loop; |
133 | |
132 | |
134 | =head1 REQUEST ANATOMY AND LIFETIME |
133 | =head1 REQUEST ANATOMY AND LIFETIME |
135 | |
134 | |
136 | Every C<aio_*> function creates a request. which is a C data structure not |
135 | Every C<aio_*> function creates a request. which is a C data structure not |
137 | directly visible to Perl. |
136 | directly visible to Perl. |
… | |
… | |
187 | |
186 | |
188 | package IO::AIO; |
187 | package IO::AIO; |
189 | |
188 | |
190 | use Carp (); |
189 | use Carp (); |
191 | |
190 | |
192 | no warnings; |
191 | use common::sense; |
193 | use strict 'vars'; |
|
|
194 | |
192 | |
195 | use base 'Exporter'; |
193 | use base 'Exporter'; |
196 | |
194 | |
197 | BEGIN { |
195 | BEGIN { |
198 | our $VERSION = '3.18'; |
196 | our $VERSION = '3.5'; |
199 | |
197 | |
200 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close |
198 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close |
201 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir |
199 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx |
202 | aio_scandir aio_symlink aio_readlink aio_sync aio_fsync |
200 | aio_scandir aio_symlink aio_readlink aio_sync aio_fsync |
203 | aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead |
201 | aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead |
204 | aio_rename aio_link aio_move aio_copy aio_group |
202 | aio_rename aio_link aio_move aio_copy aio_group |
205 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
203 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
206 | aio_chmod aio_utime aio_truncate); |
204 | aio_chmod aio_utime aio_truncate |
|
|
205 | aio_msync aio_mtouch aio_statvfs); |
207 | |
206 | |
208 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
207 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
209 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
208 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
210 | min_parallel max_parallel max_idle |
209 | min_parallel max_parallel max_idle |
211 | nreqs nready npending nthreads |
210 | nreqs nready npending nthreads |
212 | max_poll_time max_poll_reqs); |
211 | max_poll_time max_poll_reqs |
|
|
212 | sendfile fadvise); |
213 | |
213 | |
214 | push @AIO_REQ, qw(aio_busy); # not exported |
214 | push @AIO_REQ, qw(aio_busy); # not exported |
215 | |
215 | |
216 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
216 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
217 | |
217 | |
… | |
… | |
338 | |
338 | |
339 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
339 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
340 | |
340 | |
341 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
341 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
342 | |
342 | |
343 | 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 |
344 | 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> |
345 | 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 |
346 | 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. |
347 | |
350 | |
348 | If C<$offset> is undefined, then the current file descriptor offset will |
351 | If C<$offset> is undefined, then the current file descriptor offset will |
349 | be used (and updated), otherwise the file descriptor offset will not be |
352 | be used (and updated), otherwise the file descriptor offset will not be |
350 | changed by these calls. |
353 | changed by these calls. |
351 | |
354 | |
352 | If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>. |
355 | If C<$length> is undefined in C<aio_write>, use the remaining length of |
|
|
356 | C<$data>. |
353 | |
357 | |
354 | If C<$dataoffset> is less than zero, it will be counted from the end of |
358 | If C<$dataoffset> is less than zero, it will be counted from the end of |
355 | C<$data>. |
359 | C<$data>. |
356 | |
360 | |
357 | 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 |
… | |
… | |
377 | |
381 | |
378 | This call tries to make use of a native C<sendfile> syscall to provide |
382 | This call tries to make use of a native C<sendfile> syscall to provide |
379 | zero-copy operation. For this to work, C<$out_fh> should refer to a |
383 | zero-copy operation. For this to work, C<$out_fh> should refer to a |
380 | socket, and C<$in_fh> should refer to mmap'able file. |
384 | socket, and C<$in_fh> should refer to mmap'able file. |
381 | |
385 | |
382 | If the native sendfile call fails or is not implemented, it will be |
386 | If a native sendfile cannot be found or it fails with C<ENOSYS>, |
|
|
387 | C<ENOTSUP>, C<EOPNOTSUPP>, C<EAFNOSUPPORT>, C<EPROTOTYPE> or C<ENOTSOCK>, |
383 | emulated, so you can call C<aio_sendfile> on any type of filehandle |
388 | it will be emulated, so you can call C<aio_sendfile> on any type of |
384 | regardless of the limitations of the operating system. |
389 | filehandle regardless of the limitations of the operating system. |
385 | |
390 | |
386 | Please note, however, that C<aio_sendfile> can read more bytes from |
391 | Please note, however, that C<aio_sendfile> can read more bytes from |
387 | C<$in_fh> than are written, and there is no way to find out how many |
392 | C<$in_fh> than are written, and there is no way to find out how many |
388 | bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only |
393 | bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only |
389 | provides the number of bytes written to C<$out_fh>. Only if the result |
394 | provides the number of bytes written to C<$out_fh>. Only if the result |
… | |
… | |
427 | $_[0] and die "stat failed: $!"; |
432 | $_[0] and die "stat failed: $!"; |
428 | print "size is ", -s _, "\n"; |
433 | print "size is ", -s _, "\n"; |
429 | }; |
434 | }; |
430 | |
435 | |
431 | |
436 | |
|
|
437 | =item aio_statvfs $fh_or_path, $callback->($statvfs) |
|
|
438 | |
|
|
439 | Works like the POSIX C<statvfs> or C<fstatvfs> syscalls, depending on |
|
|
440 | whether a file handle or path was passed. |
|
|
441 | |
|
|
442 | On success, the callback is passed a hash reference with the following |
|
|
443 | members: C<bsize>, C<frsize>, C<blocks>, C<bfree>, C<bavail>, C<files>, |
|
|
444 | C<ffree>, C<favail>, C<fsid>, C<flag> and C<namemax>. On failure, C<undef> |
|
|
445 | is passed. |
|
|
446 | |
|
|
447 | The following POSIX IO::AIO::ST_* constants are defined: C<ST_RDONLY> and |
|
|
448 | C<ST_NOSUID>. |
|
|
449 | |
|
|
450 | The following non-POSIX IO::AIO::ST_* flag masks are defined to |
|
|
451 | their correct value when available, or to C<0> on systems that do |
|
|
452 | not support them: C<ST_NODEV>, C<ST_NOEXEC>, C<ST_SYNCHRONOUS>, |
|
|
453 | C<ST_MANDLOCK>, C<ST_WRITE>, C<ST_APPEND>, C<ST_IMMUTABLE>, C<ST_NOATIME>, |
|
|
454 | C<ST_NODIRATIME> and C<ST_RELATIME>. |
|
|
455 | |
|
|
456 | Example: stat C</wd> and dump out the data if successful. |
|
|
457 | |
|
|
458 | aio_statvfs "/wd", sub { |
|
|
459 | my $f = $_[0] |
|
|
460 | or die "statvfs: $!"; |
|
|
461 | |
|
|
462 | use Data::Dumper; |
|
|
463 | say Dumper $f; |
|
|
464 | }; |
|
|
465 | |
|
|
466 | # result: |
|
|
467 | { |
|
|
468 | bsize => 1024, |
|
|
469 | bfree => 4333064312, |
|
|
470 | blocks => 10253828096, |
|
|
471 | files => 2050765568, |
|
|
472 | flag => 4096, |
|
|
473 | favail => 2042092649, |
|
|
474 | bavail => 4333064312, |
|
|
475 | ffree => 2042092649, |
|
|
476 | namemax => 255, |
|
|
477 | frsize => 1024, |
|
|
478 | fsid => 1810 |
|
|
479 | } |
|
|
480 | |
|
|
481 | |
432 | =item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
482 | =item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
433 | |
483 | |
434 | Works like perl's C<utime> function (including the special case of $atime |
484 | Works like perl's C<utime> function (including the special case of $atime |
435 | and $mtime being undef). Fractional times are supported if the underlying |
485 | and $mtime being undef). Fractional times are supported if the underlying |
436 | syscalls support them. |
486 | syscalls support them. |
… | |
… | |
529 | |
579 | |
530 | Unlike the POSIX call of the same name, C<aio_readdir> reads an entire |
580 | Unlike the POSIX call of the same name, C<aio_readdir> reads an entire |
531 | directory (i.e. opendir + readdir + closedir). The entries will not be |
581 | directory (i.e. opendir + readdir + closedir). The entries will not be |
532 | sorted, and will B<NOT> include the C<.> and C<..> entries. |
582 | sorted, and will B<NOT> include the C<.> and C<..> entries. |
533 | |
583 | |
534 | The callback a single argument which is either C<undef> or an array-ref |
584 | The callback is passed a single argument which is either C<undef> or an |
535 | with the filenames. |
585 | array-ref with the filenames. |
|
|
586 | |
|
|
587 | |
|
|
588 | =item aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
|
|
589 | |
|
|
590 | Quite similar to C<aio_readdir>, but the C<$flags> argument allows to tune |
|
|
591 | behaviour and output format. In case of an error, C<$entries> will be |
|
|
592 | C<undef>. |
|
|
593 | |
|
|
594 | The flags are a combination of the following constants, ORed together (the |
|
|
595 | flags will also be passed to the callback, possibly modified): |
|
|
596 | |
|
|
597 | =over 4 |
|
|
598 | |
|
|
599 | =item IO::AIO::READDIR_DENTS |
|
|
600 | |
|
|
601 | When this flag is off, then the callback gets an arrayref with of names |
|
|
602 | only (as with C<aio_readdir>), otherwise it gets an arrayref with |
|
|
603 | C<[$name, $type, $inode]> arrayrefs, each describing a single directory |
|
|
604 | entry in more detail. |
|
|
605 | |
|
|
606 | C<$name> is the name of the entry. |
|
|
607 | |
|
|
608 | C<$type> is one of the C<IO::AIO::DT_xxx> constants: |
|
|
609 | |
|
|
610 | C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>, |
|
|
611 | C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>, |
|
|
612 | C<IO::AIO::DT_WHT>. |
|
|
613 | |
|
|
614 | C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to |
|
|
615 | know, you have to run stat yourself. Also, for speed reasons, the C<$type> |
|
|
616 | scalars are read-only: you can not modify them. |
|
|
617 | |
|
|
618 | C<$inode> is the inode number (which might not be exact on systems with 64 |
|
|
619 | bit inode numbers and 32 bit perls). This field has unspecified content on |
|
|
620 | systems that do not deliver the inode information. |
|
|
621 | |
|
|
622 | =item IO::AIO::READDIR_DIRS_FIRST |
|
|
623 | |
|
|
624 | When this flag is set, then the names will be returned in an order where |
|
|
625 | likely directories come first. This is useful when you need to quickly |
|
|
626 | find directories, or you want to find all directories while avoiding to |
|
|
627 | stat() each entry. |
|
|
628 | |
|
|
629 | If the system returns type information in readdir, then this is used |
|
|
630 | to find directories directly. Otherwise, likely directories are files |
|
|
631 | beginning with ".", or otherwise files with no dots, of which files with |
|
|
632 | short names are tried first. |
|
|
633 | |
|
|
634 | =item IO::AIO::READDIR_STAT_ORDER |
|
|
635 | |
|
|
636 | When this flag is set, then the names will be returned in an order |
|
|
637 | suitable for stat()'ing each one. That is, when you plan to stat() |
|
|
638 | all files in the given directory, then the returned order will likely |
|
|
639 | be fastest. |
|
|
640 | |
|
|
641 | If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, then |
|
|
642 | the likely dirs come first, resulting in a less optimal stat order. |
|
|
643 | |
|
|
644 | =item IO::AIO::READDIR_FOUND_UNKNOWN |
|
|
645 | |
|
|
646 | This flag should not be set when calling C<aio_readdirx>. Instead, it |
|
|
647 | is being set by C<aio_readdirx>, when any of the C<$type>'s found were |
|
|
648 | C<IO::AIO::DT_UNKNOWN>. The absense of this flag therefore indicates that all |
|
|
649 | C<$type>'s are known, which can be used to speed up some algorithms. |
|
|
650 | |
|
|
651 | =back |
536 | |
652 | |
537 | |
653 | |
538 | =item aio_load $path, $data, $callback->($status) |
654 | =item aio_load $path, $data, $callback->($status) |
539 | |
655 | |
540 | This is a composite request that tries to fully load the given file into |
656 | This is a composite request that tries to fully load the given file into |
… | |
… | |
565 | |
681 | |
566 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
682 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
567 | |
683 | |
568 | Try to copy the I<file> (directories not supported as either source or |
684 | Try to copy the I<file> (directories not supported as either source or |
569 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
685 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
570 | the C<0> (error) or C<-1> ok. |
686 | a status of C<0> (ok) or C<-1> (error, see C<$!>). |
571 | |
687 | |
572 | This is a composite request that creates the destination file with |
688 | This is a composite request that creates the destination file with |
573 | mode 0200 and copies the contents of the source file into it using |
689 | mode 0200 and copies the contents of the source file into it using |
574 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
690 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
575 | uid/gid, in that order. |
691 | uid/gid, in that order. |
… | |
… | |
587 | my $grp = aio_group $cb; |
703 | my $grp = aio_group $cb; |
588 | |
704 | |
589 | aioreq_pri $pri; |
705 | aioreq_pri $pri; |
590 | add $grp aio_open $src, O_RDONLY, 0, sub { |
706 | add $grp aio_open $src, O_RDONLY, 0, sub { |
591 | if (my $src_fh = $_[0]) { |
707 | if (my $src_fh = $_[0]) { |
592 | my @stat = stat $src_fh; |
708 | my @stat = stat $src_fh; # hmm, might block over nfs? |
593 | |
709 | |
594 | aioreq_pri $pri; |
710 | aioreq_pri $pri; |
595 | add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { |
711 | add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { |
596 | if (my $dst_fh = $_[0]) { |
712 | if (my $dst_fh = $_[0]) { |
597 | aioreq_pri $pri; |
713 | aioreq_pri $pri; |
598 | add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { |
714 | add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { |
599 | if ($_[0] == $stat[7]) { |
715 | if ($_[0] == $stat[7]) { |
600 | $grp->result (0); |
716 | $grp->result (0); |
601 | close $src_fh; |
717 | close $src_fh; |
602 | |
718 | |
603 | # those should not normally block. should. should. |
719 | my $ch = sub { |
604 | utime $stat[8], $stat[9], $dst; |
720 | aioreq_pri $pri; |
605 | chmod $stat[2] & 07777, $dst_fh; |
721 | add $grp aio_chmod $dst_fh, $stat[2] & 07777, sub { |
606 | chown $stat[4], $stat[5], $dst_fh; |
722 | aioreq_pri $pri; |
|
|
723 | add $grp aio_chown $dst_fh, $stat[4], $stat[5], sub { |
|
|
724 | aioreq_pri $pri; |
|
|
725 | add $grp aio_close $dst_fh; |
|
|
726 | } |
|
|
727 | }; |
|
|
728 | }; |
607 | |
729 | |
608 | aioreq_pri $pri; |
730 | aioreq_pri $pri; |
609 | add $grp aio_close $dst_fh; |
731 | add $grp aio_utime $dst_fh, $stat[8], $stat[9], sub { |
|
|
732 | if ($_[0] < 0 && $! == ENOSYS) { |
|
|
733 | aioreq_pri $pri; |
|
|
734 | add $grp aio_utime $dst, $stat[8], $stat[9], $ch; |
|
|
735 | } else { |
|
|
736 | $ch->(); |
|
|
737 | } |
|
|
738 | }; |
610 | } else { |
739 | } else { |
611 | $grp->result (-1); |
740 | $grp->result (-1); |
612 | close $src_fh; |
741 | close $src_fh; |
613 | close $dst_fh; |
742 | close $dst_fh; |
614 | |
743 | |
… | |
… | |
631 | |
760 | |
632 | =item aio_move $srcpath, $dstpath, $callback->($status) |
761 | =item aio_move $srcpath, $dstpath, $callback->($status) |
633 | |
762 | |
634 | Try to move the I<file> (directories not supported as either source or |
763 | Try to move the I<file> (directories not supported as either source or |
635 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
764 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
636 | the C<0> (error) or C<-1> ok. |
765 | a status of C<0> (ok) or C<-1> (error, see C<$!>). |
637 | |
766 | |
638 | This is a composite request that tries to rename(2) the file first; if |
767 | This is a composite request that tries to rename(2) the file first; if |
639 | rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if |
768 | rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if |
640 | that is successful, unlinks the C<$srcpath>. |
769 | that is successful, unlinks the C<$srcpath>. |
641 | |
770 | |
… | |
… | |
692 | |
821 | |
693 | Implementation notes. |
822 | Implementation notes. |
694 | |
823 | |
695 | The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can. |
824 | The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can. |
696 | |
825 | |
|
|
826 | If readdir returns file type information, then this is used directly to |
|
|
827 | find directories. |
|
|
828 | |
697 | After reading the directory, the modification time, size etc. of the |
829 | Otherwise, after reading the directory, the modification time, size etc. |
698 | directory before and after the readdir is checked, and if they match (and |
830 | of the directory before and after the readdir is checked, and if they |
699 | isn't the current time), the link count will be used to decide how many |
831 | match (and isn't the current time), the link count will be used to decide |
700 | entries are directories (if >= 2). Otherwise, no knowledge of the number |
832 | how many entries are directories (if >= 2). Otherwise, no knowledge of the |
701 | of subdirectories will be assumed. |
833 | number of subdirectories will be assumed. |
702 | |
834 | |
703 | Then entries will be sorted into likely directories (everything without |
835 | Then entries will be sorted into likely directories a non-initial dot |
704 | a non-initial dot currently) and likely non-directories (everything |
836 | currently) and likely non-directories (see C<aio_readdirx>). Then every |
705 | else). Then every entry plus an appended C</.> will be C<stat>'ed, |
837 | entry plus an appended C</.> will be C<stat>'ed, likely directories first, |
706 | likely directories first. If that succeeds, it assumes that the entry |
838 | in order of their inode numbers. If that succeeds, it assumes that the |
707 | is a directory or a symlink to directory (which will be checked |
839 | entry is a directory or a symlink to directory (which will be checked |
708 | seperately). This is often faster than stat'ing the entry itself because |
840 | seperately). This is often faster than stat'ing the entry itself because |
709 | filesystems might detect the type of the entry without reading the inode |
841 | filesystems might detect the type of the entry without reading the inode |
710 | data (e.g. ext2fs filetype feature). |
842 | data (e.g. ext2fs filetype feature), even on systems that cannot return |
|
|
843 | the filetype information on readdir. |
711 | |
844 | |
712 | If the known number of directories (link count - 2) has been reached, the |
845 | If the known number of directories (link count - 2) has been reached, the |
713 | rest of the entries is assumed to be non-directories. |
846 | rest of the entries is assumed to be non-directories. |
714 | |
847 | |
715 | This only works with certainty on POSIX (= UNIX) filesystems, which |
848 | This only works with certainty on POSIX (= UNIX) filesystems, which |
… | |
… | |
737 | my $now = time; |
870 | my $now = time; |
738 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
871 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
739 | |
872 | |
740 | # read the directory entries |
873 | # read the directory entries |
741 | aioreq_pri $pri; |
874 | aioreq_pri $pri; |
742 | add $grp aio_readdir $path, sub { |
875 | add $grp aio_readdirx $path, READDIR_DIRS_FIRST, sub { |
743 | my $entries = shift |
876 | my $entries = shift |
744 | or return $grp->result (); |
877 | or return $grp->result (); |
745 | |
878 | |
746 | # stat the dir another time |
879 | # stat the dir another time |
747 | aioreq_pri $pri; |
880 | aioreq_pri $pri; |
… | |
… | |
753 | # take the slow route if anything looks fishy |
886 | # take the slow route if anything looks fishy |
754 | if ($hash1 ne $hash2 or (stat _)[9] == $now) { |
887 | if ($hash1 ne $hash2 or (stat _)[9] == $now) { |
755 | $ndirs = -1; |
888 | $ndirs = -1; |
756 | } else { |
889 | } else { |
757 | # if nlink == 2, we are finished |
890 | # if nlink == 2, we are finished |
758 | # on non-posix-fs's, we rely on nlink < 2 |
891 | # for non-posix-fs's, we rely on nlink < 2 |
759 | $ndirs = (stat _)[3] - 2 |
892 | $ndirs = (stat _)[3] - 2 |
760 | or return $grp->result ([], $entries); |
893 | or return $grp->result ([], $entries); |
761 | } |
894 | } |
762 | |
895 | |
763 | # sort into likely dirs and likely nondirs |
|
|
764 | # dirs == files without ".", short entries first |
|
|
765 | $entries = [map $_->[0], |
|
|
766 | sort { $b->[1] cmp $a->[1] } |
|
|
767 | map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], |
|
|
768 | @$entries]; |
|
|
769 | |
|
|
770 | my (@dirs, @nondirs); |
896 | my (@dirs, @nondirs); |
771 | |
897 | |
772 | my $statgrp = add $grp aio_group sub { |
898 | my $statgrp = add $grp aio_group sub { |
773 | $grp->result (\@dirs, \@nondirs); |
899 | $grp->result (\@dirs, \@nondirs); |
774 | }; |
900 | }; |
775 | |
901 | |
776 | limit $statgrp $maxreq; |
902 | limit $statgrp $maxreq; |
777 | feed $statgrp sub { |
903 | feed $statgrp sub { |
778 | return unless @$entries; |
904 | return unless @$entries; |
779 | my $entry = pop @$entries; |
905 | my $entry = shift @$entries; |
780 | |
906 | |
781 | aioreq_pri $pri; |
907 | aioreq_pri $pri; |
782 | add $statgrp aio_stat "$path/$entry/.", sub { |
908 | add $statgrp aio_stat "$path/$entry/.", sub { |
783 | if ($_[0] < 0) { |
909 | if ($_[0] < 0) { |
784 | push @nondirs, $entry; |
910 | push @nondirs, $entry; |
… | |
… | |
878 | (E.g. rename). This might not work on all operating systems or have any |
1004 | (E.g. rename). This might not work on all operating systems or have any |
879 | specific effect, but usually it makes sure that directory changes get |
1005 | specific effect, but usually it makes sure that directory changes get |
880 | written to disc. It works for anything that can be opened for read-only, |
1006 | written to disc. It works for anything that can be opened for read-only, |
881 | not just directories. |
1007 | not just directories. |
882 | |
1008 | |
|
|
1009 | Future versions of this function might fall back to other methods when |
|
|
1010 | C<fsync> on the directory fails (such as calling C<sync>). |
|
|
1011 | |
883 | Passes C<0> when everything went ok, and C<-1> on error. |
1012 | Passes C<0> when everything went ok, and C<-1> on error. |
884 | |
1013 | |
885 | =cut |
1014 | =cut |
886 | |
1015 | |
887 | sub aio_pathsync($;$) { |
1016 | sub aio_pathsync($;$) { |
… | |
… | |
907 | }; |
1036 | }; |
908 | |
1037 | |
909 | $grp |
1038 | $grp |
910 | } |
1039 | } |
911 | |
1040 | |
|
|
1041 | =item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
|
|
1042 | |
|
|
1043 | This is a rather advanced IO::AIO call, which only works on mmap(2)ed |
|
|
1044 | scalars (see the L<Sys::Mmap> or L<Mmap> modules for details on this, note |
|
|
1045 | that the scalar must only be modified in-place while an aio operation is |
|
|
1046 | pending on it). |
|
|
1047 | |
|
|
1048 | It calls the C<msync> function of your OS, if available, with the memory |
|
|
1049 | area starting at C<$offset> in the string and ending C<$length> bytes |
|
|
1050 | later. If C<$length> is negative, counts from the end, and if C<$length> |
|
|
1051 | is C<undef>, then it goes till the end of the string. The flags can be |
|
|
1052 | a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and |
|
|
1053 | C<IO::AIO::MS_SYNC>. |
|
|
1054 | |
|
|
1055 | =item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
|
|
1056 | |
|
|
1057 | This is a rather advanced IO::AIO call, which works best on mmap(2)ed |
|
|
1058 | scalars. |
|
|
1059 | |
|
|
1060 | It touches (reads or writes) all memory pages in the specified |
|
|
1061 | range inside the scalar. All caveats and parameters are the same |
|
|
1062 | as for C<aio_msync>, above, except for flags, which must be either |
|
|
1063 | C<0> (which reads all pages and ensures they are instantiated) or |
|
|
1064 | C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and |
|
|
1065 | writing an octet from it, which dirties the page). |
|
|
1066 | |
912 | =item aio_group $callback->(...) |
1067 | =item aio_group $callback->(...) |
913 | |
1068 | |
914 | This is a very special aio request: Instead of doing something, it is a |
1069 | This is a very special aio request: Instead of doing something, it is a |
915 | container for other aio requests, which is useful if you want to bundle |
1070 | container for other aio requests, which is useful if you want to bundle |
916 | many requests into a single, composite, request with a definite callback |
1071 | many requests into a single, composite, request with a definite callback |
… | |
… | |
965 | =item cancel $req |
1120 | =item cancel $req |
966 | |
1121 | |
967 | Cancels the request, if possible. Has the effect of skipping execution |
1122 | Cancels the request, if possible. Has the effect of skipping execution |
968 | when entering the B<execute> state and skipping calling the callback when |
1123 | when entering the B<execute> state and skipping calling the callback when |
969 | entering the the B<result> state, but will leave the request otherwise |
1124 | entering the the B<result> state, but will leave the request otherwise |
970 | untouched. That means that requests that currently execute will not be |
1125 | untouched (with the exception of readdir). That means that requests that |
971 | stopped and resources held by the request will not be freed prematurely. |
1126 | currently execute will not be stopped and resources held by the request |
|
|
1127 | will not be freed prematurely. |
972 | |
1128 | |
973 | =item cb $req $callback->(...) |
1129 | =item cb $req $callback->(...) |
974 | |
1130 | |
975 | Replace (or simply set) the callback registered to the request. |
1131 | Replace (or simply set) the callback registered to the request. |
976 | |
1132 | |
… | |
… | |
1049 | |
1205 | |
1050 | =item $grp->cancel_subs |
1206 | =item $grp->cancel_subs |
1051 | |
1207 | |
1052 | Cancel all subrequests and clears any feeder, but not the group request |
1208 | Cancel all subrequests and clears any feeder, but not the group request |
1053 | itself. Useful when you queued a lot of events but got a result early. |
1209 | itself. Useful when you queued a lot of events but got a result early. |
|
|
1210 | |
|
|
1211 | The group request will finish normally (you cannot add requests to the |
|
|
1212 | group). |
1054 | |
1213 | |
1055 | =item $grp->result (...) |
1214 | =item $grp->result (...) |
1056 | |
1215 | |
1057 | Set the result value(s) that will be passed to the group callback when all |
1216 | Set the result value(s) that will be passed to the group callback when all |
1058 | subrequests have finished and set the groups errno to the current value |
1217 | subrequests have finished and set the groups errno to the current value |
… | |
… | |
1127 | =over 4 |
1286 | =over 4 |
1128 | |
1287 | |
1129 | =item $fileno = IO::AIO::poll_fileno |
1288 | =item $fileno = IO::AIO::poll_fileno |
1130 | |
1289 | |
1131 | Return the I<request result pipe file descriptor>. This filehandle must be |
1290 | Return the I<request result pipe file descriptor>. This filehandle must be |
1132 | polled for reading by some mechanism outside this module (e.g. Event or |
1291 | polled for reading by some mechanism outside this module (e.g. EV, Glib, |
1133 | select, see below or the SYNOPSIS). If the pipe becomes readable you have |
1292 | select and so on, see below or the SYNOPSIS). If the pipe becomes readable |
1134 | to call C<poll_cb> to check the results. |
1293 | you have to call C<poll_cb> to check the results. |
1135 | |
1294 | |
1136 | See C<poll_cb> for an example. |
1295 | See C<poll_cb> for an example. |
1137 | |
1296 | |
1138 | =item IO::AIO::poll_cb |
1297 | =item IO::AIO::poll_cb |
1139 | |
1298 | |
… | |
… | |
1146 | If not all requests were processed for whatever reason, the filehandle |
1305 | If not all requests were processed for whatever reason, the filehandle |
1147 | will still be ready when C<poll_cb> returns, so normally you don't have to |
1306 | will still be ready when C<poll_cb> returns, so normally you don't have to |
1148 | do anything special to have it called later. |
1307 | do anything special to have it called later. |
1149 | |
1308 | |
1150 | Example: Install an Event watcher that automatically calls |
1309 | Example: Install an Event watcher that automatically calls |
1151 | IO::AIO::poll_cb with high priority: |
1310 | IO::AIO::poll_cb with high priority (more examples can be found in the |
|
|
1311 | SYNOPSIS section, at the top of this document): |
1152 | |
1312 | |
1153 | Event->io (fd => IO::AIO::poll_fileno, |
1313 | Event->io (fd => IO::AIO::poll_fileno, |
1154 | poll => 'r', async => 1, |
1314 | poll => 'r', async => 1, |
1155 | cb => \&IO::AIO::poll_cb); |
1315 | cb => \&IO::AIO::poll_cb); |
1156 | |
1316 | |
… | |
… | |
1310 | |
1470 | |
1311 | =item IO::AIO::npending |
1471 | =item IO::AIO::npending |
1312 | |
1472 | |
1313 | Returns the number of requests currently in the pending state (executed, |
1473 | Returns the number of requests currently in the pending state (executed, |
1314 | but not yet processed by poll_cb). |
1474 | but not yet processed by poll_cb). |
|
|
1475 | |
|
|
1476 | =back |
|
|
1477 | |
|
|
1478 | =head3 MISCELLANEOUS FUNCTIONS |
|
|
1479 | |
|
|
1480 | IO::AIO implements some functions that might be useful, but are not |
|
|
1481 | asynchronous. |
|
|
1482 | |
|
|
1483 | =over 4 |
|
|
1484 | |
|
|
1485 | =item IO::AIO::sendfile $ofh, $ifh, $offset, $count |
|
|
1486 | |
|
|
1487 | Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>, |
|
|
1488 | but is blocking (this makes most sense if you know the input data is |
|
|
1489 | likely cached already and the output filehandle is set to non-blocking |
|
|
1490 | operations). |
|
|
1491 | |
|
|
1492 | Returns the number of bytes copied, or C<-1> on error. |
|
|
1493 | |
|
|
1494 | =item IO::AIO::fadvise $fh, $offset, $len, $advice |
|
|
1495 | |
|
|
1496 | Simply calls the C<posix_fadvise> function (see it's |
|
|
1497 | manpage for details). The following advice constants are |
|
|
1498 | avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>, |
|
|
1499 | C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>, |
|
|
1500 | C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>. |
|
|
1501 | |
|
|
1502 | On systems that do not implement C<posix_fadvise>, this function returns |
|
|
1503 | ENOSYS, otherwise the return value of C<posix_fadvise>. |
1315 | |
1504 | |
1316 | =back |
1505 | =back |
1317 | |
1506 | |
1318 | =cut |
1507 | =cut |
1319 | |
1508 | |