… | |
… | |
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 | |
|
|
34 | # EV integration |
|
|
35 | my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; |
|
|
36 | |
|
|
37 | # Event integration |
|
|
38 | Event->io (fd => IO::AIO::poll_fileno, |
|
|
39 | poll => 'r', |
|
|
40 | cb => \&IO::AIO::poll_cb); |
|
|
41 | |
|
|
42 | # Glib/Gtk2 integration |
|
|
43 | add_watch Glib::IO IO::AIO::poll_fileno, |
|
|
44 | in => sub { IO::AIO::poll_cb; 1 }; |
|
|
45 | |
|
|
46 | # Tk integration |
|
|
47 | Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "", |
|
|
48 | readable => \&IO::AIO::poll_cb); |
|
|
49 | |
|
|
50 | # Danga::Socket integration |
|
|
51 | Danga::Socket->AddOtherFds (IO::AIO::poll_fileno => |
|
|
52 | \&IO::AIO::poll_cb); |
|
|
53 | |
|
|
54 | =head1 DESCRIPTION |
31 | =head1 DESCRIPTION |
55 | |
32 | |
56 | This module implements asynchronous I/O using whatever means your |
33 | This module implements asynchronous I/O using whatever means your |
57 | operating system supports. |
34 | operating system supports. It is implemented as an interface to C<libeio> |
|
|
35 | (L<http://software.schmorp.de/pkg/libeio.html>). |
58 | |
36 | |
59 | Asynchronous means that operations that can normally block your program |
37 | Asynchronous means that operations that can normally block your program |
60 | (e.g. reading from disk) will be done asynchronously: the operation |
38 | (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 |
39 | 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 |
40 | 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 |
44 | on a RAID volume or over NFS when you do a number of stat operations |
67 | concurrently. |
45 | concurrently. |
68 | |
46 | |
69 | While most of this works on all types of file descriptors (for |
47 | While most of this works on all types of file descriptors (for |
70 | example sockets), using these functions on file descriptors that |
48 | example sockets), using these functions on file descriptors that |
71 | support nonblocking operation (again, sockets, pipes etc.) is very |
49 | support nonblocking operation (again, sockets, pipes etc.) is |
72 | inefficient. Use an event loop for that (such as the L<Event|Event> |
50 | 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. |
51 | module): IO::AIO will naturally fit into such an event loop itself. |
74 | |
52 | |
75 | In this version, a number of threads are started that execute your |
53 | In this version, a number of threads are started that execute your |
76 | requests and signal their completion. You don't need thread support |
54 | 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 |
55 | 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 |
65 | yourself, always call C<poll_cb> from within the same thread, or never |
88 | call C<poll_cb> (or other C<aio_> functions) recursively. |
66 | call C<poll_cb> (or other C<aio_> functions) recursively. |
89 | |
67 | |
90 | =head2 EXAMPLE |
68 | =head2 EXAMPLE |
91 | |
69 | |
92 | This is a simple example that uses the Event module and loads |
70 | This is a simple example that uses the EV module and loads |
93 | F</etc/passwd> asynchronously: |
71 | F</etc/passwd> asynchronously: |
94 | |
72 | |
95 | use Fcntl; |
73 | use Fcntl; |
96 | use Event; |
74 | use EV; |
97 | use IO::AIO; |
75 | use IO::AIO; |
98 | |
76 | |
99 | # register the IO::AIO callback with Event |
77 | # register the IO::AIO callback with EV |
100 | Event->io (fd => IO::AIO::poll_fileno, |
78 | 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 | |
79 | |
104 | # queue the request to open /etc/passwd |
80 | # queue the request to open /etc/passwd |
105 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
81 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
106 | my $fh = shift |
82 | my $fh = shift |
107 | or die "error while opening: $!"; |
83 | or die "error while opening: $!"; |
… | |
… | |
119 | |
95 | |
120 | # file contents now in $contents |
96 | # file contents now in $contents |
121 | print $contents; |
97 | print $contents; |
122 | |
98 | |
123 | # exit event loop and program |
99 | # exit event loop and program |
124 | Event::unloop; |
100 | EV::unloop; |
125 | }; |
101 | }; |
126 | }; |
102 | }; |
127 | |
103 | |
128 | # possibly queue up other requests, or open GUI windows, |
104 | # possibly queue up other requests, or open GUI windows, |
129 | # check for sockets etc. etc. |
105 | # check for sockets etc. etc. |
130 | |
106 | |
131 | # process events as long as there are some: |
107 | # process events as long as there are some: |
132 | Event::loop; |
108 | EV::loop; |
133 | |
109 | |
134 | =head1 REQUEST ANATOMY AND LIFETIME |
110 | =head1 REQUEST ANATOMY AND LIFETIME |
135 | |
111 | |
136 | Every C<aio_*> function creates a request. which is a C data structure not |
112 | Every C<aio_*> function creates a request. which is a C data structure not |
137 | directly visible to Perl. |
113 | directly visible to Perl. |
… | |
… | |
187 | |
163 | |
188 | package IO::AIO; |
164 | package IO::AIO; |
189 | |
165 | |
190 | use Carp (); |
166 | use Carp (); |
191 | |
167 | |
192 | no warnings; |
168 | use common::sense; |
193 | use strict 'vars'; |
|
|
194 | |
169 | |
195 | use base 'Exporter'; |
170 | use base 'Exporter'; |
196 | |
171 | |
197 | BEGIN { |
172 | BEGIN { |
198 | our $VERSION = '3.22'; |
173 | our $VERSION = '3.5'; |
199 | |
174 | |
200 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close |
175 | 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 aio_readdirx |
176 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx |
202 | aio_scandir aio_symlink aio_readlink aio_sync aio_fsync |
177 | aio_scandir aio_symlink aio_readlink aio_sync aio_fsync |
203 | aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead |
178 | aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead |
204 | aio_rename aio_link aio_move aio_copy aio_group |
179 | aio_rename aio_link aio_move aio_copy aio_group |
205 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
180 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
206 | aio_chmod aio_utime aio_truncate); |
181 | aio_chmod aio_utime aio_truncate |
|
|
182 | aio_msync aio_mtouch aio_statvfs); |
207 | |
183 | |
208 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
184 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
209 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
185 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
210 | min_parallel max_parallel max_idle |
186 | min_parallel max_parallel max_idle |
211 | nreqs nready npending nthreads |
187 | nreqs nready npending nthreads |
212 | max_poll_time max_poll_reqs); |
188 | max_poll_time max_poll_reqs |
|
|
189 | sendfile fadvise); |
213 | |
190 | |
214 | push @AIO_REQ, qw(aio_busy); # not exported |
191 | push @AIO_REQ, qw(aio_busy); # not exported |
215 | |
192 | |
216 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
193 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
217 | |
194 | |
218 | require XSLoader; |
195 | require XSLoader; |
219 | XSLoader::load ("IO::AIO", $VERSION); |
196 | XSLoader::load ("IO::AIO", $VERSION); |
220 | } |
197 | } |
221 | |
198 | |
222 | =head1 FUNCTIONS |
199 | =head1 FUNCTIONS |
|
|
200 | |
|
|
201 | =head2 QUICK OVERVIEW |
|
|
202 | |
|
|
203 | This section simply lists the prototypes of the most important functions |
|
|
204 | for quick reference. See the following sections for function-by-function |
|
|
205 | documentation. |
|
|
206 | |
|
|
207 | aio_open $pathname, $flags, $mode, $callback->($fh) |
|
|
208 | aio_close $fh, $callback->($status) |
|
|
209 | aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
|
|
210 | aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
|
|
211 | aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
|
|
212 | aio_readahead $fh,$offset,$length, $callback->($retval) |
|
|
213 | aio_stat $fh_or_path, $callback->($status) |
|
|
214 | aio_lstat $fh, $callback->($status) |
|
|
215 | aio_statvfs $fh_or_path, $callback->($statvfs) |
|
|
216 | aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
|
|
217 | aio_chown $fh_or_path, $uid, $gid, $callback->($status) |
|
|
218 | aio_truncate $fh_or_path, $offset, $callback->($status) |
|
|
219 | aio_chmod $fh_or_path, $mode, $callback->($status) |
|
|
220 | aio_unlink $pathname, $callback->($status) |
|
|
221 | aio_mknod $path, $mode, $dev, $callback->($status) |
|
|
222 | aio_link $srcpath, $dstpath, $callback->($status) |
|
|
223 | aio_symlink $srcpath, $dstpath, $callback->($status) |
|
|
224 | aio_readlink $path, $callback->($link) |
|
|
225 | aio_rename $srcpath, $dstpath, $callback->($status) |
|
|
226 | aio_mkdir $pathname, $mode, $callback->($status) |
|
|
227 | aio_rmdir $pathname, $callback->($status) |
|
|
228 | aio_readdir $pathname, $callback->($entries) |
|
|
229 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
|
|
230 | IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST |
|
|
231 | IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN |
|
|
232 | aio_load $path, $data, $callback->($status) |
|
|
233 | aio_copy $srcpath, $dstpath, $callback->($status) |
|
|
234 | aio_move $srcpath, $dstpath, $callback->($status) |
|
|
235 | aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
|
|
236 | aio_rmtree $path, $callback->($status) |
|
|
237 | aio_sync $callback->($status) |
|
|
238 | aio_fsync $fh, $callback->($status) |
|
|
239 | aio_fdatasync $fh, $callback->($status) |
|
|
240 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
|
|
241 | aio_pathsync $path, $callback->($status) |
|
|
242 | aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
|
|
243 | aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
|
|
244 | aio_group $callback->(...) |
|
|
245 | aio_nop $callback->() |
|
|
246 | |
|
|
247 | $prev_pri = aioreq_pri [$pri] |
|
|
248 | aioreq_nice $pri_adjust |
|
|
249 | |
|
|
250 | IO::AIO::poll_wait |
|
|
251 | IO::AIO::poll_cb |
|
|
252 | IO::AIO::poll |
|
|
253 | IO::AIO::flush |
|
|
254 | IO::AIO::max_poll_reqs $nreqs |
|
|
255 | IO::AIO::max_poll_time $seconds |
|
|
256 | IO::AIO::min_parallel $nthreads |
|
|
257 | IO::AIO::max_parallel $nthreads |
|
|
258 | IO::AIO::max_idle $nthreads |
|
|
259 | IO::AIO::max_outstanding $maxreqs |
|
|
260 | IO::AIO::nreqs |
|
|
261 | IO::AIO::nready |
|
|
262 | IO::AIO::npending |
|
|
263 | |
|
|
264 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
|
|
265 | IO::AIO::fadvise $fh, $offset, $len, $advice |
|
|
266 | IO::AIO::mlockall $flags |
|
|
267 | IO::AIO::munlockall |
223 | |
268 | |
224 | =head2 AIO REQUEST FUNCTIONS |
269 | =head2 AIO REQUEST FUNCTIONS |
225 | |
270 | |
226 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
271 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
227 | with the same name (sans C<aio_>). The arguments are similar or identical, |
272 | with the same name (sans C<aio_>). The arguments are similar or identical, |
… | |
… | |
381 | |
426 | |
382 | This call tries to make use of a native C<sendfile> syscall to provide |
427 | This call tries to make use of a native C<sendfile> syscall to provide |
383 | zero-copy operation. For this to work, C<$out_fh> should refer to a |
428 | zero-copy operation. For this to work, C<$out_fh> should refer to a |
384 | socket, and C<$in_fh> should refer to mmap'able file. |
429 | socket, and C<$in_fh> should refer to mmap'able file. |
385 | |
430 | |
386 | If the native sendfile call fails or is not implemented, it will be |
431 | If a native sendfile cannot be found or it fails with C<ENOSYS>, |
|
|
432 | C<ENOTSUP>, C<EOPNOTSUPP>, C<EAFNOSUPPORT>, C<EPROTOTYPE> or C<ENOTSOCK>, |
387 | emulated, so you can call C<aio_sendfile> on any type of filehandle |
433 | it will be emulated, so you can call C<aio_sendfile> on any type of |
388 | regardless of the limitations of the operating system. |
434 | filehandle regardless of the limitations of the operating system. |
389 | |
435 | |
390 | Please note, however, that C<aio_sendfile> can read more bytes from |
436 | Please note, however, that C<aio_sendfile> can read more bytes from |
391 | C<$in_fh> than are written, and there is no way to find out how many |
437 | C<$in_fh> than are written, and there is no way to find out how many |
392 | bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only |
438 | bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only |
393 | provides the number of bytes written to C<$out_fh>. Only if the result |
439 | provides the number of bytes written to C<$out_fh>. Only if the result |
… | |
… | |
431 | $_[0] and die "stat failed: $!"; |
477 | $_[0] and die "stat failed: $!"; |
432 | print "size is ", -s _, "\n"; |
478 | print "size is ", -s _, "\n"; |
433 | }; |
479 | }; |
434 | |
480 | |
435 | |
481 | |
|
|
482 | =item aio_statvfs $fh_or_path, $callback->($statvfs) |
|
|
483 | |
|
|
484 | Works like the POSIX C<statvfs> or C<fstatvfs> syscalls, depending on |
|
|
485 | whether a file handle or path was passed. |
|
|
486 | |
|
|
487 | On success, the callback is passed a hash reference with the following |
|
|
488 | members: C<bsize>, C<frsize>, C<blocks>, C<bfree>, C<bavail>, C<files>, |
|
|
489 | C<ffree>, C<favail>, C<fsid>, C<flag> and C<namemax>. On failure, C<undef> |
|
|
490 | is passed. |
|
|
491 | |
|
|
492 | The following POSIX IO::AIO::ST_* constants are defined: C<ST_RDONLY> and |
|
|
493 | C<ST_NOSUID>. |
|
|
494 | |
|
|
495 | The following non-POSIX IO::AIO::ST_* flag masks are defined to |
|
|
496 | their correct value when available, or to C<0> on systems that do |
|
|
497 | not support them: C<ST_NODEV>, C<ST_NOEXEC>, C<ST_SYNCHRONOUS>, |
|
|
498 | C<ST_MANDLOCK>, C<ST_WRITE>, C<ST_APPEND>, C<ST_IMMUTABLE>, C<ST_NOATIME>, |
|
|
499 | C<ST_NODIRATIME> and C<ST_RELATIME>. |
|
|
500 | |
|
|
501 | Example: stat C</wd> and dump out the data if successful. |
|
|
502 | |
|
|
503 | aio_statvfs "/wd", sub { |
|
|
504 | my $f = $_[0] |
|
|
505 | or die "statvfs: $!"; |
|
|
506 | |
|
|
507 | use Data::Dumper; |
|
|
508 | say Dumper $f; |
|
|
509 | }; |
|
|
510 | |
|
|
511 | # result: |
|
|
512 | { |
|
|
513 | bsize => 1024, |
|
|
514 | bfree => 4333064312, |
|
|
515 | blocks => 10253828096, |
|
|
516 | files => 2050765568, |
|
|
517 | flag => 4096, |
|
|
518 | favail => 2042092649, |
|
|
519 | bavail => 4333064312, |
|
|
520 | ffree => 2042092649, |
|
|
521 | namemax => 255, |
|
|
522 | frsize => 1024, |
|
|
523 | fsid => 1810 |
|
|
524 | } |
|
|
525 | |
|
|
526 | |
436 | =item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
527 | =item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
437 | |
528 | |
438 | Works like perl's C<utime> function (including the special case of $atime |
529 | Works like perl's C<utime> function (including the special case of $atime |
439 | and $mtime being undef). Fractional times are supported if the underlying |
530 | and $mtime being undef). Fractional times are supported if the underlying |
440 | syscalls support them. |
531 | syscalls support them. |
… | |
… | |
568 | C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to |
659 | C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to |
569 | know, you have to run stat yourself. Also, for speed reasons, the C<$type> |
660 | know, you have to run stat yourself. Also, for speed reasons, the C<$type> |
570 | scalars are read-only: you can not modify them. |
661 | scalars are read-only: you can not modify them. |
571 | |
662 | |
572 | C<$inode> is the inode number (which might not be exact on systems with 64 |
663 | C<$inode> is the inode number (which might not be exact on systems with 64 |
573 | bit inode numbers and 32 bit perls). On systems that do not deliver the |
664 | bit inode numbers and 32 bit perls). This field has unspecified content on |
574 | inode information, this will always be zero. |
665 | systems that do not deliver the inode information. |
575 | |
666 | |
576 | =item IO::AIO::READDIR_DIRS_FIRST |
667 | =item IO::AIO::READDIR_DIRS_FIRST |
577 | |
668 | |
578 | When this flag is set, then the names will be returned in an order where |
669 | When this flag is set, then the names will be returned in an order where |
579 | likely directories come first. This is useful when you need to quickly |
670 | likely directories come first. This is useful when you need to quickly |
… | |
… | |
635 | |
726 | |
636 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
727 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
637 | |
728 | |
638 | Try to copy the I<file> (directories not supported as either source or |
729 | Try to copy the I<file> (directories not supported as either source or |
639 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
730 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
640 | the C<0> (error) or C<-1> ok. |
731 | a status of C<0> (ok) or C<-1> (error, see C<$!>). |
641 | |
732 | |
642 | This is a composite request that creates the destination file with |
733 | This is a composite request that creates the destination file with |
643 | mode 0200 and copies the contents of the source file into it using |
734 | mode 0200 and copies the contents of the source file into it using |
644 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
735 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
645 | uid/gid, in that order. |
736 | uid/gid, in that order. |
… | |
… | |
657 | my $grp = aio_group $cb; |
748 | my $grp = aio_group $cb; |
658 | |
749 | |
659 | aioreq_pri $pri; |
750 | aioreq_pri $pri; |
660 | add $grp aio_open $src, O_RDONLY, 0, sub { |
751 | add $grp aio_open $src, O_RDONLY, 0, sub { |
661 | if (my $src_fh = $_[0]) { |
752 | if (my $src_fh = $_[0]) { |
662 | my @stat = stat $src_fh; # hmm, might bock over nfs? |
753 | my @stat = stat $src_fh; # hmm, might block over nfs? |
663 | |
754 | |
664 | aioreq_pri $pri; |
755 | aioreq_pri $pri; |
665 | add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { |
756 | add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { |
666 | if (my $dst_fh = $_[0]) { |
757 | if (my $dst_fh = $_[0]) { |
667 | aioreq_pri $pri; |
758 | aioreq_pri $pri; |
… | |
… | |
714 | |
805 | |
715 | =item aio_move $srcpath, $dstpath, $callback->($status) |
806 | =item aio_move $srcpath, $dstpath, $callback->($status) |
716 | |
807 | |
717 | Try to move the I<file> (directories not supported as either source or |
808 | Try to move the I<file> (directories not supported as either source or |
718 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
809 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
719 | the C<0> (error) or C<-1> ok. |
810 | a status of C<0> (ok) or C<-1> (error, see C<$!>). |
720 | |
811 | |
721 | This is a composite request that tries to rename(2) the file first; if |
812 | This is a composite request that tries to rename(2) the file first; if |
722 | rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if |
813 | rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if |
723 | that is successful, unlinks the C<$srcpath>. |
814 | that is successful, unlinks the C<$srcpath>. |
724 | |
815 | |
… | |
… | |
958 | (E.g. rename). This might not work on all operating systems or have any |
1049 | (E.g. rename). This might not work on all operating systems or have any |
959 | specific effect, but usually it makes sure that directory changes get |
1050 | specific effect, but usually it makes sure that directory changes get |
960 | written to disc. It works for anything that can be opened for read-only, |
1051 | written to disc. It works for anything that can be opened for read-only, |
961 | not just directories. |
1052 | not just directories. |
962 | |
1053 | |
|
|
1054 | Future versions of this function might fall back to other methods when |
|
|
1055 | C<fsync> on the directory fails (such as calling C<sync>). |
|
|
1056 | |
963 | Passes C<0> when everything went ok, and C<-1> on error. |
1057 | Passes C<0> when everything went ok, and C<-1> on error. |
964 | |
1058 | |
965 | =cut |
1059 | =cut |
966 | |
1060 | |
967 | sub aio_pathsync($;$) { |
1061 | sub aio_pathsync($;$) { |
… | |
… | |
987 | }; |
1081 | }; |
988 | |
1082 | |
989 | $grp |
1083 | $grp |
990 | } |
1084 | } |
991 | |
1085 | |
|
|
1086 | =item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
|
|
1087 | |
|
|
1088 | This is a rather advanced IO::AIO call, which only works on mmap(2)ed |
|
|
1089 | scalars (see the L<Sys::Mmap> or L<Mmap> modules for details on this, note |
|
|
1090 | that the scalar must only be modified in-place while an aio operation is |
|
|
1091 | pending on it). |
|
|
1092 | |
|
|
1093 | It calls the C<msync> function of your OS, if available, with the memory |
|
|
1094 | area starting at C<$offset> in the string and ending C<$length> bytes |
|
|
1095 | later. If C<$length> is negative, counts from the end, and if C<$length> |
|
|
1096 | is C<undef>, then it goes till the end of the string. The flags can be |
|
|
1097 | a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and |
|
|
1098 | C<IO::AIO::MS_SYNC>. |
|
|
1099 | |
|
|
1100 | =item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
|
|
1101 | |
|
|
1102 | This is a rather advanced IO::AIO call, which works best on mmap(2)ed |
|
|
1103 | scalars. |
|
|
1104 | |
|
|
1105 | It touches (reads or writes) all memory pages in the specified |
|
|
1106 | range inside the scalar. All caveats and parameters are the same |
|
|
1107 | as for C<aio_msync>, above, except for flags, which must be either |
|
|
1108 | C<0> (which reads all pages and ensures they are instantiated) or |
|
|
1109 | C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and |
|
|
1110 | writing an octet from it, which dirties the page). |
|
|
1111 | |
992 | =item aio_group $callback->(...) |
1112 | =item aio_group $callback->(...) |
993 | |
1113 | |
994 | This is a very special aio request: Instead of doing something, it is a |
1114 | This is a very special aio request: Instead of doing something, it is a |
995 | container for other aio requests, which is useful if you want to bundle |
1115 | container for other aio requests, which is useful if you want to bundle |
996 | many requests into a single, composite, request with a definite callback |
1116 | many requests into a single, composite, request with a definite callback |
… | |
… | |
1131 | =item $grp->cancel_subs |
1251 | =item $grp->cancel_subs |
1132 | |
1252 | |
1133 | Cancel all subrequests and clears any feeder, but not the group request |
1253 | Cancel all subrequests and clears any feeder, but not the group request |
1134 | itself. Useful when you queued a lot of events but got a result early. |
1254 | itself. Useful when you queued a lot of events but got a result early. |
1135 | |
1255 | |
|
|
1256 | The group request will finish normally (you cannot add requests to the |
|
|
1257 | group). |
|
|
1258 | |
1136 | =item $grp->result (...) |
1259 | =item $grp->result (...) |
1137 | |
1260 | |
1138 | Set the result value(s) that will be passed to the group callback when all |
1261 | Set the result value(s) that will be passed to the group callback when all |
1139 | subrequests have finished and set the groups errno to the current value |
1262 | subrequests have finished and set the groups errno to the current value |
1140 | of errno (just like calling C<errno> without an error number). By default, |
1263 | of errno (just like calling C<errno> without an error number). By default, |
… | |
… | |
1208 | =over 4 |
1331 | =over 4 |
1209 | |
1332 | |
1210 | =item $fileno = IO::AIO::poll_fileno |
1333 | =item $fileno = IO::AIO::poll_fileno |
1211 | |
1334 | |
1212 | Return the I<request result pipe file descriptor>. This filehandle must be |
1335 | Return the I<request result pipe file descriptor>. This filehandle must be |
1213 | polled for reading by some mechanism outside this module (e.g. Event or |
1336 | polled for reading by some mechanism outside this module (e.g. EV, Glib, |
1214 | select, see below or the SYNOPSIS). If the pipe becomes readable you have |
1337 | select and so on, see below or the SYNOPSIS). If the pipe becomes readable |
1215 | to call C<poll_cb> to check the results. |
1338 | you have to call C<poll_cb> to check the results. |
1216 | |
1339 | |
1217 | See C<poll_cb> for an example. |
1340 | See C<poll_cb> for an example. |
1218 | |
1341 | |
1219 | =item IO::AIO::poll_cb |
1342 | =item IO::AIO::poll_cb |
1220 | |
1343 | |
… | |
… | |
1227 | If not all requests were processed for whatever reason, the filehandle |
1350 | If not all requests were processed for whatever reason, the filehandle |
1228 | will still be ready when C<poll_cb> returns, so normally you don't have to |
1351 | will still be ready when C<poll_cb> returns, so normally you don't have to |
1229 | do anything special to have it called later. |
1352 | do anything special to have it called later. |
1230 | |
1353 | |
1231 | Example: Install an Event watcher that automatically calls |
1354 | Example: Install an Event watcher that automatically calls |
1232 | IO::AIO::poll_cb with high priority: |
1355 | IO::AIO::poll_cb with high priority (more examples can be found in the |
|
|
1356 | SYNOPSIS section, at the top of this document): |
1233 | |
1357 | |
1234 | Event->io (fd => IO::AIO::poll_fileno, |
1358 | Event->io (fd => IO::AIO::poll_fileno, |
1235 | poll => 'r', async => 1, |
1359 | poll => 'r', async => 1, |
1236 | cb => \&IO::AIO::poll_cb); |
1360 | cb => \&IO::AIO::poll_cb); |
|
|
1361 | |
|
|
1362 | =item IO::AIO::poll_wait |
|
|
1363 | |
|
|
1364 | If there are any outstanding requests and none of them in the result |
|
|
1365 | phase, wait till the result filehandle becomes ready for reading (simply |
|
|
1366 | does a C<select> on the filehandle. This is useful if you want to |
|
|
1367 | synchronously wait for some requests to finish). |
|
|
1368 | |
|
|
1369 | See C<nreqs> for an example. |
|
|
1370 | |
|
|
1371 | =item IO::AIO::poll |
|
|
1372 | |
|
|
1373 | Waits until some requests have been handled. |
|
|
1374 | |
|
|
1375 | Returns the number of requests processed, but is otherwise strictly |
|
|
1376 | equivalent to: |
|
|
1377 | |
|
|
1378 | IO::AIO::poll_wait, IO::AIO::poll_cb |
|
|
1379 | |
|
|
1380 | =item IO::AIO::flush |
|
|
1381 | |
|
|
1382 | Wait till all outstanding AIO requests have been handled. |
|
|
1383 | |
|
|
1384 | Strictly equivalent to: |
|
|
1385 | |
|
|
1386 | IO::AIO::poll_wait, IO::AIO::poll_cb |
|
|
1387 | while IO::AIO::nreqs; |
1237 | |
1388 | |
1238 | =item IO::AIO::max_poll_reqs $nreqs |
1389 | =item IO::AIO::max_poll_reqs $nreqs |
1239 | |
1390 | |
1240 | =item IO::AIO::max_poll_time $seconds |
1391 | =item IO::AIO::max_poll_time $seconds |
1241 | |
1392 | |
… | |
… | |
1266 | # use a low priority so other tasks have priority |
1417 | # use a low priority so other tasks have priority |
1267 | Event->io (fd => IO::AIO::poll_fileno, |
1418 | Event->io (fd => IO::AIO::poll_fileno, |
1268 | poll => 'r', nice => 1, |
1419 | poll => 'r', nice => 1, |
1269 | cb => &IO::AIO::poll_cb); |
1420 | cb => &IO::AIO::poll_cb); |
1270 | |
1421 | |
1271 | =item IO::AIO::poll_wait |
|
|
1272 | |
|
|
1273 | If there are any outstanding requests and none of them in the result |
|
|
1274 | phase, wait till the result filehandle becomes ready for reading (simply |
|
|
1275 | does a C<select> on the filehandle. This is useful if you want to |
|
|
1276 | synchronously wait for some requests to finish). |
|
|
1277 | |
|
|
1278 | See C<nreqs> for an example. |
|
|
1279 | |
|
|
1280 | =item IO::AIO::poll |
|
|
1281 | |
|
|
1282 | Waits until some requests have been handled. |
|
|
1283 | |
|
|
1284 | Returns the number of requests processed, but is otherwise strictly |
|
|
1285 | equivalent to: |
|
|
1286 | |
|
|
1287 | IO::AIO::poll_wait, IO::AIO::poll_cb |
|
|
1288 | |
|
|
1289 | =item IO::AIO::flush |
|
|
1290 | |
|
|
1291 | Wait till all outstanding AIO requests have been handled. |
|
|
1292 | |
|
|
1293 | Strictly equivalent to: |
|
|
1294 | |
|
|
1295 | IO::AIO::poll_wait, IO::AIO::poll_cb |
|
|
1296 | while IO::AIO::nreqs; |
|
|
1297 | |
|
|
1298 | =back |
1422 | =back |
1299 | |
1423 | |
1300 | =head3 CONTROLLING THE NUMBER OF THREADS |
1424 | =head3 CONTROLLING THE NUMBER OF THREADS |
1301 | |
1425 | |
1302 | =over |
1426 | =over |
… | |
… | |
1394 | Returns the number of requests currently in the pending state (executed, |
1518 | Returns the number of requests currently in the pending state (executed, |
1395 | but not yet processed by poll_cb). |
1519 | but not yet processed by poll_cb). |
1396 | |
1520 | |
1397 | =back |
1521 | =back |
1398 | |
1522 | |
|
|
1523 | =head3 MISCELLANEOUS FUNCTIONS |
|
|
1524 | |
|
|
1525 | IO::AIO implements some functions that might be useful, but are not |
|
|
1526 | asynchronous. |
|
|
1527 | |
|
|
1528 | =over 4 |
|
|
1529 | |
|
|
1530 | =item IO::AIO::sendfile $ofh, $ifh, $offset, $count |
|
|
1531 | |
|
|
1532 | Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>, |
|
|
1533 | but is blocking (this makes most sense if you know the input data is |
|
|
1534 | likely cached already and the output filehandle is set to non-blocking |
|
|
1535 | operations). |
|
|
1536 | |
|
|
1537 | Returns the number of bytes copied, or C<-1> on error. |
|
|
1538 | |
|
|
1539 | =item IO::AIO::fadvise $fh, $offset, $len, $advice |
|
|
1540 | |
|
|
1541 | Simply calls the C<posix_fadvise> function (see it's |
|
|
1542 | manpage for details). The following advice constants are |
|
|
1543 | avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>, |
|
|
1544 | C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>, |
|
|
1545 | C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>. |
|
|
1546 | |
|
|
1547 | On systems that do not implement C<posix_fadvise>, this function returns |
|
|
1548 | ENOSYS, otherwise the return value of C<posix_fadvise>. |
|
|
1549 | |
|
|
1550 | =item IO::AIO::mlockall $flags |
|
|
1551 | |
|
|
1552 | Calls the C<mlockall> function with the given C<$flags> (a combination of |
|
|
1553 | C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL__FUTURE>). |
|
|
1554 | |
|
|
1555 | On systems that do not implement C<mlockall>, this function returns |
|
|
1556 | ENOSYS, otherwise the return value of C<mlockall>. |
|
|
1557 | |
|
|
1558 | =item IO::AIO::munlockall |
|
|
1559 | |
|
|
1560 | Calls the C<munlockall> function. |
|
|
1561 | |
|
|
1562 | On systems that do not implement C<munlockall>, this function returns |
|
|
1563 | ENOSYS, otherwise the return value of C<munlockall>. |
|
|
1564 | |
|
|
1565 | =back |
|
|
1566 | |
1399 | =cut |
1567 | =cut |
1400 | |
1568 | |
1401 | min_parallel 8; |
1569 | min_parallel 8; |
1402 | |
1570 | |
1403 | END { flush } |
1571 | END { flush } |
1404 | |
1572 | |
1405 | 1; |
1573 | 1; |
|
|
1574 | |
|
|
1575 | =head1 EVENT LOOP INTEGRATION |
|
|
1576 | |
|
|
1577 | It is recommended to use L<AnyEvent::AIO> to integrate IO::AIO |
|
|
1578 | automatically into many event loops: |
|
|
1579 | |
|
|
1580 | # AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...) |
|
|
1581 | use AnyEvent::AIO; |
|
|
1582 | |
|
|
1583 | You can also integrate IO::AIO manually into many event loops, here are |
|
|
1584 | some examples of how to do this: |
|
|
1585 | |
|
|
1586 | # EV integration |
|
|
1587 | my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; |
|
|
1588 | |
|
|
1589 | # Event integration |
|
|
1590 | Event->io (fd => IO::AIO::poll_fileno, |
|
|
1591 | poll => 'r', |
|
|
1592 | cb => \&IO::AIO::poll_cb); |
|
|
1593 | |
|
|
1594 | # Glib/Gtk2 integration |
|
|
1595 | add_watch Glib::IO IO::AIO::poll_fileno, |
|
|
1596 | in => sub { IO::AIO::poll_cb; 1 }; |
|
|
1597 | |
|
|
1598 | # Tk integration |
|
|
1599 | Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "", |
|
|
1600 | readable => \&IO::AIO::poll_cb); |
|
|
1601 | |
|
|
1602 | # Danga::Socket integration |
|
|
1603 | Danga::Socket->AddOtherFds (IO::AIO::poll_fileno => |
|
|
1604 | \&IO::AIO::poll_cb); |
1406 | |
1605 | |
1407 | =head2 FORK BEHAVIOUR |
1606 | =head2 FORK BEHAVIOUR |
1408 | |
1607 | |
1409 | This module should do "the right thing" when the process using it forks: |
1608 | This module should do "the right thing" when the process using it forks: |
1410 | |
1609 | |