1 |
=head1 NAME |
2 |
|
3 |
Coro::AIO - truly asynchronous file and directrory I/O |
4 |
|
5 |
=head1 SYNOPSIS |
6 |
|
7 |
use Coro::AIO; |
8 |
|
9 |
# can now use any of the aio requests your IO::AIO module supports. |
10 |
|
11 |
# read 1MB of /etc/passwd, without blocking other coroutines |
12 |
my $fh = aio_open "/etc/passwd", O_RDONLY, 0 |
13 |
or die "/etc/passwd: $!"; |
14 |
aio_read $fh, 0, 1_000_000, my $buf, 0 |
15 |
or die "aio_read: $!"; |
16 |
aio_close $fh; |
17 |
|
18 |
=head1 DESCRIPTION |
19 |
|
20 |
This module implements a thin wrapper around L<IO::AIO|IO::AIO>. All of |
21 |
the functions that expect a callback are being wrapped by this module. |
22 |
|
23 |
The API is exactly the same as that of the corresponding IO::AIO routines, |
24 |
except that you have to specify I<all> arguments I<except> the callback |
25 |
argument. Instead the routines return the values normally passed to the |
26 |
callback. Everything else, including C<$!> and perls stat cache, are set |
27 |
as expected after these functions return. |
28 |
|
29 |
You can mix calls to C<IO::AIO> functions with calls to this module. You |
30 |
I<must not>, however, call these routines from within IO::AIO callbacks, |
31 |
as this causes a deadlock. Start a coro inside the callback instead. |
32 |
|
33 |
You also can, but do not need to, call C<IO::AIO::poll_cb>, as this |
34 |
module automatically installs an event watcher for the C<IO::AIO> file |
35 |
descriptor. It uses the L<AnyEvent|AnyEvent> module for this, so please |
36 |
refer to its documentation on how it selects an appropriate Event module. |
37 |
|
38 |
All other functions exported by default by IO::AIO (e.g. C<aioreq_pri>) |
39 |
will be exported by default by Coro::AIO, too. |
40 |
|
41 |
Functions that can be optionally imported from IO::AIO can be imported |
42 |
from Coro::AIO or can be called directly, e.g. C<Coro::AIO::nreqs>. |
43 |
|
44 |
You cannot specify priorities with C<aioreq_pri>, as this module |
45 |
overwrites the request priority with the current coroutine priority at all |
46 |
times. |
47 |
|
48 |
For your convienience, here are the changed function signatures for most |
49 |
of the requests, for documentation of these functions please have a look |
50 |
at L<IO::AIO|the IO::AIO manual>. |
51 |
|
52 |
The AnyEvent watcher can be disabled by executing C<undef |
53 |
$Coro::AIO::WATCHER>. Please notify the author of when and why you think |
54 |
this was necessary. |
55 |
|
56 |
=over 4 |
57 |
|
58 |
=cut |
59 |
|
60 |
package Coro::AIO; |
61 |
|
62 |
use strict qw(subs vars); |
63 |
|
64 |
use Coro (); |
65 |
use AnyEvent; |
66 |
use IO::AIO (); |
67 |
|
68 |
use base Exporter::; |
69 |
|
70 |
if (AnyEvent::detect =~ /^AnyEvent::Impl::(Coro)?EV$/) { |
71 |
$WATCHER = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; |
72 |
} else { |
73 |
our $FH; open $FH, "<&=" . IO::AIO::poll_fileno; |
74 |
$WATCHER = AnyEvent->io (fh => $FH, poll => 'r', cb => \&IO::AIO::poll_cb); |
75 |
} |
76 |
|
77 |
|
78 |
our @EXPORT = @IO::AIO::EXPORT; |
79 |
our @EXPORT_OK = @IO::AIO::EXPORT_OK; |
80 |
our $AUTOLOAD; |
81 |
|
82 |
{ |
83 |
my @reqs = @IO::AIO::AIO_REQ ? @IO::AIO::AIO_REQ : @EXPORT; |
84 |
my %reqs = map +($_ => 1), @reqs; |
85 |
|
86 |
eval |
87 |
join "", |
88 |
map "sub $_(" . (prototype "IO::AIO::$_") . ");", |
89 |
grep !$reqs{$_}, |
90 |
@EXPORT, @EXPORT_OK; |
91 |
|
92 |
for my $sub (@reqs) { |
93 |
push @EXPORT, $sub; |
94 |
|
95 |
my $iosub = "IO::AIO::$sub"; |
96 |
my $proto = prototype $iosub; |
97 |
|
98 |
$proto =~ s/;?\$$// or die "$iosub: unable to remove callback slot from prototype"; |
99 |
|
100 |
eval qq{ |
101 |
#line 1 "Coro::AIO::$sub($proto)" |
102 |
sub $sub($proto) { |
103 |
my \$current = \$Coro::current; |
104 |
my \$state; |
105 |
my \@res; |
106 |
|
107 |
push \@_, sub { |
108 |
\$state = _get_state; |
109 |
\@res = \@_; |
110 |
\$current->ready; |
111 |
}; |
112 |
|
113 |
aioreq_pri \$Coro::current->prio; |
114 |
&$iosub; |
115 |
|
116 |
&Coro::schedule; |
117 |
&Coro::schedule while !\$state; |
118 |
|
119 |
_set_state \$state; |
120 |
wantarray ? \@res : \$res[0] |
121 |
} |
122 |
}; |
123 |
die if $@; |
124 |
} |
125 |
} |
126 |
|
127 |
sub AUTOLOAD { |
128 |
(my $func = $AUTOLOAD) =~ s/^.*:://; |
129 |
*$AUTOLOAD = \&{"IO::AIO::$func"}; |
130 |
goto &$AUTOLOAD; |
131 |
} |
132 |
|
133 |
=item $fh = aio_open $pathname, $flags, $mode |
134 |
|
135 |
=item $status = aio_close $fh |
136 |
|
137 |
=item $retval = aio_read $fh,$offset,$length, $data,$dataoffset |
138 |
|
139 |
=item $retval = aio_write $fh,$offset,$length, $data,$dataoffset |
140 |
|
141 |
=item $retval = aio_sendfile $out_fh, $in_fh, $in_offset, $length |
142 |
|
143 |
=item $retval = aio_readahead $fh,$offset,$length |
144 |
|
145 |
=item $status = aio_stat $fh_or_path |
146 |
|
147 |
=item $status = aio_lstat $fh |
148 |
|
149 |
=item $status = aio_unlink $pathname |
150 |
|
151 |
=item $status = aio_rmdir $pathname |
152 |
|
153 |
=item $entries = aio_readdir $pathname |
154 |
|
155 |
=item ($dirs, $nondirs) = aio_scandir $path, $maxreq |
156 |
|
157 |
=item $status = aio_fsync $fh |
158 |
|
159 |
=item $status = aio_fdatasync $fh |
160 |
|
161 |
=item ... = aio_xxx ... |
162 |
|
163 |
Any additional aio requests follow the same scheme: same parameters except |
164 |
you must not specify a callback but instead get the callback arguments as |
165 |
return values. |
166 |
|
167 |
=back |
168 |
|
169 |
=head1 SEE ALSO |
170 |
|
171 |
L<Coro::Socket> and L<Coro::Handle> for non-blocking socket operation. |
172 |
|
173 |
=head1 AUTHOR |
174 |
|
175 |
Marc Lehmann <schmorp@schmorp.de> |
176 |
http://home.schmorp.de/ |
177 |
|
178 |
=cut |
179 |
|
180 |
1 |