1 |
root |
1.1 |
=head1 NAME |
2 |
|
|
|
3 |
|
|
IO::AIO - Asynchronous Input/Output |
4 |
|
|
|
5 |
|
|
=head1 SYNOPSIS |
6 |
|
|
|
7 |
|
|
use IO::AIO; |
8 |
|
|
|
9 |
root |
1.6 |
aio_open "/etc/passwd", O_RDONLY, 0, sub { |
10 |
root |
1.94 |
my $fh = shift |
11 |
|
|
or die "/etc/passwd: $!"; |
12 |
root |
1.6 |
... |
13 |
|
|
}; |
14 |
|
|
|
15 |
|
|
aio_unlink "/tmp/file", sub { }; |
16 |
|
|
|
17 |
|
|
aio_read $fh, 30000, 1024, $buffer, 0, sub { |
18 |
root |
1.8 |
$_[0] > 0 or die "read error: $!"; |
19 |
root |
1.6 |
}; |
20 |
|
|
|
21 |
root |
1.56 |
# version 2+ has request and group objects |
22 |
|
|
use IO::AIO 2; |
23 |
root |
1.52 |
|
24 |
root |
1.68 |
aioreq_pri 4; # give next request a very high priority |
25 |
root |
1.52 |
my $req = aio_unlink "/tmp/file", sub { }; |
26 |
|
|
$req->cancel; # cancel request if still in queue |
27 |
|
|
|
28 |
root |
1.56 |
my $grp = aio_group sub { print "all stats done\n" }; |
29 |
|
|
add $grp aio_stat "..." for ...; |
30 |
|
|
|
31 |
|
|
# AnyEvent integration |
32 |
root |
1.42 |
open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!"; |
33 |
|
|
my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb }); |
34 |
|
|
|
35 |
root |
1.56 |
# Event integration |
36 |
root |
1.6 |
Event->io (fd => IO::AIO::poll_fileno, |
37 |
root |
1.7 |
poll => 'r', |
38 |
root |
1.6 |
cb => \&IO::AIO::poll_cb); |
39 |
|
|
|
40 |
root |
1.56 |
# Glib/Gtk2 integration |
41 |
root |
1.6 |
add_watch Glib::IO IO::AIO::poll_fileno, |
42 |
root |
1.22 |
in => sub { IO::AIO::poll_cb; 1 }; |
43 |
root |
1.6 |
|
44 |
root |
1.56 |
# Tk integration |
45 |
root |
1.6 |
Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "", |
46 |
|
|
readable => \&IO::AIO::poll_cb); |
47 |
|
|
|
48 |
root |
1.56 |
# Danga::Socket integration |
49 |
root |
1.11 |
Danga::Socket->AddOtherFds (IO::AIO::poll_fileno => |
50 |
|
|
\&IO::AIO::poll_cb); |
51 |
|
|
|
52 |
root |
1.1 |
=head1 DESCRIPTION |
53 |
|
|
|
54 |
|
|
This module implements asynchronous I/O using whatever means your |
55 |
root |
1.2 |
operating system supports. |
56 |
root |
1.1 |
|
57 |
root |
1.85 |
Asynchronous means that operations that can normally block your program |
58 |
|
|
(e.g. reading from disk) will be done asynchronously: the operation |
59 |
|
|
will still block, but you can do something else in the meantime. This |
60 |
|
|
is extremely useful for programs that need to stay interactive even |
61 |
|
|
when doing heavy I/O (GUI programs, high performance network servers |
62 |
|
|
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 |
64 |
|
|
on a RAID volume or over NFS when you do a number of stat operations |
65 |
|
|
concurrently. |
66 |
|
|
|
67 |
root |
1.108 |
While most of this works on all types of file descriptors (for |
68 |
|
|
example sockets), using these functions on file descriptors that |
69 |
|
|
support nonblocking operation (again, sockets, pipes etc.) is very |
70 |
|
|
inefficient. Use an event loop for that (such as the L<Event|Event> |
71 |
|
|
module): IO::AIO will naturally fit into such an event loop itself. |
72 |
root |
1.85 |
|
73 |
root |
1.72 |
In this version, a number of threads are started that execute your |
74 |
|
|
requests and signal their completion. You don't need thread support |
75 |
|
|
in perl, and the threads created by this module will not be visible |
76 |
|
|
to perl. In the future, this module might make use of the native aio |
77 |
|
|
functions available on many operating systems. However, they are often |
78 |
root |
1.85 |
not well-supported or restricted (GNU/Linux doesn't allow them on normal |
79 |
root |
1.72 |
files currently, for example), and they would only support aio_read and |
80 |
|
|
aio_write, so the remaining functionality would have to be implemented |
81 |
|
|
using threads anyway. |
82 |
|
|
|
83 |
root |
1.108 |
Although the module will work in the presence of other (Perl-) threads, |
84 |
|
|
it is currently not reentrant in any way, so use appropriate locking |
85 |
|
|
yourself, always call C<poll_cb> from within the same thread, or never |
86 |
|
|
call C<poll_cb> (or other C<aio_> functions) recursively. |
87 |
root |
1.72 |
|
88 |
root |
1.86 |
=head2 EXAMPLE |
89 |
|
|
|
90 |
|
|
This is a simple example that uses the Event module and loads |
91 |
|
|
F</etc/passwd> asynchronously: |
92 |
|
|
|
93 |
|
|
use Fcntl; |
94 |
|
|
use Event; |
95 |
|
|
use IO::AIO; |
96 |
|
|
|
97 |
|
|
# register the IO::AIO callback with Event |
98 |
|
|
Event->io (fd => IO::AIO::poll_fileno, |
99 |
|
|
poll => 'r', |
100 |
|
|
cb => \&IO::AIO::poll_cb); |
101 |
|
|
|
102 |
|
|
# queue the request to open /etc/passwd |
103 |
|
|
aio_open "/etc/passwd", O_RDONLY, 0, sub { |
104 |
root |
1.94 |
my $fh = shift |
105 |
root |
1.86 |
or die "error while opening: $!"; |
106 |
|
|
|
107 |
|
|
# stat'ing filehandles is generally non-blocking |
108 |
|
|
my $size = -s $fh; |
109 |
|
|
|
110 |
|
|
# queue a request to read the file |
111 |
|
|
my $contents; |
112 |
|
|
aio_read $fh, 0, $size, $contents, 0, sub { |
113 |
|
|
$_[0] == $size |
114 |
|
|
or die "short read: $!"; |
115 |
|
|
|
116 |
|
|
close $fh; |
117 |
|
|
|
118 |
|
|
# file contents now in $contents |
119 |
|
|
print $contents; |
120 |
|
|
|
121 |
|
|
# exit event loop and program |
122 |
|
|
Event::unloop; |
123 |
|
|
}; |
124 |
|
|
}; |
125 |
|
|
|
126 |
|
|
# possibly queue up other requests, or open GUI windows, |
127 |
|
|
# check for sockets etc. etc. |
128 |
|
|
|
129 |
|
|
# process events as long as there are some: |
130 |
|
|
Event::loop; |
131 |
|
|
|
132 |
root |
1.72 |
=head1 REQUEST ANATOMY AND LIFETIME |
133 |
|
|
|
134 |
|
|
Every C<aio_*> function creates a request. which is a C data structure not |
135 |
|
|
directly visible to Perl. |
136 |
|
|
|
137 |
|
|
If called in non-void context, every request function returns a Perl |
138 |
|
|
object representing the request. In void context, nothing is returned, |
139 |
|
|
which saves a bit of memory. |
140 |
|
|
|
141 |
|
|
The perl object is a fairly standard ref-to-hash object. The hash contents |
142 |
|
|
are not used by IO::AIO so you are free to store anything you like in it. |
143 |
|
|
|
144 |
|
|
During their existance, aio requests travel through the following states, |
145 |
|
|
in order: |
146 |
|
|
|
147 |
|
|
=over 4 |
148 |
|
|
|
149 |
|
|
=item ready |
150 |
|
|
|
151 |
|
|
Immediately after a request is created it is put into the ready state, |
152 |
|
|
waiting for a thread to execute it. |
153 |
|
|
|
154 |
|
|
=item execute |
155 |
|
|
|
156 |
|
|
A thread has accepted the request for processing and is currently |
157 |
|
|
executing it (e.g. blocking in read). |
158 |
|
|
|
159 |
|
|
=item pending |
160 |
|
|
|
161 |
|
|
The request has been executed and is waiting for result processing. |
162 |
|
|
|
163 |
|
|
While request submission and execution is fully asynchronous, result |
164 |
|
|
processing is not and relies on the perl interpreter calling C<poll_cb> |
165 |
|
|
(or another function with the same effect). |
166 |
|
|
|
167 |
|
|
=item result |
168 |
|
|
|
169 |
|
|
The request results are processed synchronously by C<poll_cb>. |
170 |
|
|
|
171 |
|
|
The C<poll_cb> function will process all outstanding aio requests by |
172 |
|
|
calling their callbacks, freeing memory associated with them and managing |
173 |
|
|
any groups they are contained in. |
174 |
|
|
|
175 |
|
|
=item done |
176 |
|
|
|
177 |
|
|
Request has reached the end of its lifetime and holds no resources anymore |
178 |
|
|
(except possibly for the Perl object, but its connection to the actual |
179 |
|
|
aio request is severed and calling its methods will either do nothing or |
180 |
|
|
result in a runtime error). |
181 |
root |
1.1 |
|
182 |
root |
1.88 |
=back |
183 |
|
|
|
184 |
root |
1.1 |
=cut |
185 |
|
|
|
186 |
|
|
package IO::AIO; |
187 |
|
|
|
188 |
root |
1.23 |
no warnings; |
189 |
root |
1.51 |
use strict 'vars'; |
190 |
root |
1.23 |
|
191 |
root |
1.1 |
use base 'Exporter'; |
192 |
|
|
|
193 |
|
|
BEGIN { |
194 |
root |
1.106 |
our $VERSION = '2.4'; |
195 |
root |
1.1 |
|
196 |
root |
1.67 |
our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat |
197 |
|
|
aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink |
198 |
root |
1.90 |
aio_readlink aio_fsync aio_fdatasync aio_readahead aio_rename aio_link |
199 |
root |
1.106 |
aio_move aio_copy aio_group aio_nop aio_mknod aio_load aio_rmtree aio_mkdir |
200 |
|
|
aio_chown aio_chmod aio_utime); |
201 |
root |
1.95 |
our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block)); |
202 |
root |
1.67 |
our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
203 |
root |
1.86 |
min_parallel max_parallel max_idle |
204 |
|
|
nreqs nready npending nthreads |
205 |
|
|
max_poll_time max_poll_reqs); |
206 |
root |
1.1 |
|
207 |
root |
1.54 |
@IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
208 |
|
|
|
209 |
root |
1.1 |
require XSLoader; |
210 |
root |
1.51 |
XSLoader::load ("IO::AIO", $VERSION); |
211 |
root |
1.1 |
} |
212 |
|
|
|
213 |
root |
1.5 |
=head1 FUNCTIONS |
214 |
root |
1.1 |
|
215 |
root |
1.87 |
=head2 AIO REQUEST FUNCTIONS |
216 |
root |
1.1 |
|
217 |
root |
1.5 |
All the C<aio_*> calls are more or less thin wrappers around the syscall |
218 |
|
|
with the same name (sans C<aio_>). The arguments are similar or identical, |
219 |
root |
1.14 |
and they all accept an additional (and optional) C<$callback> argument |
220 |
|
|
which must be a code reference. This code reference will get called with |
221 |
|
|
the syscall return code (e.g. most syscalls return C<-1> on error, unlike |
222 |
|
|
perl, which usually delivers "false") as it's sole argument when the given |
223 |
|
|
syscall has been executed asynchronously. |
224 |
root |
1.1 |
|
225 |
root |
1.23 |
All functions expecting a filehandle keep a copy of the filehandle |
226 |
|
|
internally until the request has finished. |
227 |
root |
1.1 |
|
228 |
root |
1.87 |
All functions return request objects of type L<IO::AIO::REQ> that allow |
229 |
|
|
further manipulation of those requests while they are in-flight. |
230 |
root |
1.52 |
|
231 |
root |
1.28 |
The pathnames you pass to these routines I<must> be absolute and |
232 |
root |
1.87 |
encoded as octets. The reason for the former is that at the time the |
233 |
root |
1.28 |
request is being executed, the current working directory could have |
234 |
|
|
changed. Alternatively, you can make sure that you never change the |
235 |
root |
1.87 |
current working directory anywhere in the program and then use relative |
236 |
|
|
paths. |
237 |
root |
1.28 |
|
238 |
root |
1.87 |
To encode pathnames as octets, either make sure you either: a) always pass |
239 |
|
|
in filenames you got from outside (command line, readdir etc.) without |
240 |
|
|
tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module and encode |
241 |
root |
1.28 |
your pathnames to the locale (or other) encoding in effect in the user |
242 |
|
|
environment, d) use Glib::filename_from_unicode on unicode filenames or e) |
243 |
root |
1.87 |
use something else to ensure your scalar has the correct contents. |
244 |
|
|
|
245 |
|
|
This works, btw. independent of the internal UTF-8 bit, which IO::AIO |
246 |
|
|
handles correctly wether it is set or not. |
247 |
root |
1.1 |
|
248 |
root |
1.5 |
=over 4 |
249 |
root |
1.1 |
|
250 |
root |
1.80 |
=item $prev_pri = aioreq_pri [$pri] |
251 |
root |
1.68 |
|
252 |
root |
1.80 |
Returns the priority value that would be used for the next request and, if |
253 |
|
|
C<$pri> is given, sets the priority for the next aio request. |
254 |
root |
1.68 |
|
255 |
root |
1.80 |
The default priority is C<0>, the minimum and maximum priorities are C<-4> |
256 |
|
|
and C<4>, respectively. Requests with higher priority will be serviced |
257 |
|
|
first. |
258 |
|
|
|
259 |
|
|
The priority will be reset to C<0> after each call to one of the C<aio_*> |
260 |
root |
1.68 |
functions. |
261 |
|
|
|
262 |
root |
1.69 |
Example: open a file with low priority, then read something from it with |
263 |
|
|
higher priority so the read request is serviced before other low priority |
264 |
|
|
open requests (potentially spamming the cache): |
265 |
|
|
|
266 |
|
|
aioreq_pri -3; |
267 |
|
|
aio_open ..., sub { |
268 |
|
|
return unless $_[0]; |
269 |
|
|
|
270 |
|
|
aioreq_pri -2; |
271 |
|
|
aio_read $_[0], ..., sub { |
272 |
|
|
... |
273 |
|
|
}; |
274 |
|
|
}; |
275 |
|
|
|
276 |
root |
1.106 |
|
277 |
root |
1.69 |
=item aioreq_nice $pri_adjust |
278 |
|
|
|
279 |
|
|
Similar to C<aioreq_pri>, but subtracts the given value from the current |
280 |
root |
1.87 |
priority, so the effect is cumulative. |
281 |
root |
1.69 |
|
282 |
root |
1.106 |
|
283 |
root |
1.40 |
=item aio_open $pathname, $flags, $mode, $callback->($fh) |
284 |
root |
1.1 |
|
285 |
root |
1.2 |
Asynchronously open or create a file and call the callback with a newly |
286 |
|
|
created filehandle for the file. |
287 |
root |
1.1 |
|
288 |
|
|
The pathname passed to C<aio_open> must be absolute. See API NOTES, above, |
289 |
|
|
for an explanation. |
290 |
|
|
|
291 |
root |
1.20 |
The C<$flags> argument is a bitmask. See the C<Fcntl> module for a |
292 |
|
|
list. They are the same as used by C<sysopen>. |
293 |
|
|
|
294 |
|
|
Likewise, C<$mode> specifies the mode of the newly created file, if it |
295 |
|
|
didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>, |
296 |
|
|
except that it is mandatory (i.e. use C<0> if you don't create new files, |
297 |
root |
1.101 |
and C<0666> or C<0777> if you do). Note that the C<$mode> will be modified |
298 |
|
|
by the umask in effect then the request is being executed, so better never |
299 |
|
|
change the umask. |
300 |
root |
1.1 |
|
301 |
|
|
Example: |
302 |
|
|
|
303 |
|
|
aio_open "/etc/passwd", O_RDONLY, 0, sub { |
304 |
root |
1.2 |
if ($_[0]) { |
305 |
|
|
print "open successful, fh is $_[0]\n"; |
306 |
root |
1.1 |
... |
307 |
|
|
} else { |
308 |
|
|
die "open failed: $!\n"; |
309 |
|
|
} |
310 |
|
|
}; |
311 |
|
|
|
312 |
root |
1.106 |
|
313 |
root |
1.40 |
=item aio_close $fh, $callback->($status) |
314 |
root |
1.1 |
|
315 |
root |
1.2 |
Asynchronously close a file and call the callback with the result |
316 |
|
|
code. I<WARNING:> although accepted, you should not pass in a perl |
317 |
root |
1.20 |
filehandle here, as perl will likely close the file descriptor another |
318 |
|
|
time when the filehandle is destroyed. Normally, you can safely call perls |
319 |
|
|
C<close> or just let filehandles go out of scope. |
320 |
|
|
|
321 |
|
|
This is supposed to be a bug in the API, so that might change. It's |
322 |
|
|
therefore best to avoid this function. |
323 |
root |
1.1 |
|
324 |
root |
1.106 |
|
325 |
root |
1.40 |
=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
326 |
root |
1.1 |
|
327 |
root |
1.40 |
=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
328 |
root |
1.1 |
|
329 |
root |
1.109 |
Reads or writes C<$length> bytes from the specified C<$fh> and C<$offset> |
330 |
|
|
into the scalar given by C<$data> and offset C<$dataoffset> and calls the |
331 |
root |
1.1 |
callback without the actual number of bytes read (or -1 on error, just |
332 |
root |
1.109 |
like the syscall). |
333 |
|
|
|
334 |
|
|
If C<$offset> is undefined, then the current file offset will be used (and |
335 |
|
|
updated), otherwise the file offset will not be changed by these calls. |
336 |
|
|
|
337 |
|
|
If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>. |
338 |
|
|
|
339 |
|
|
If C<$dataoffset> is less than zero, it will be counted from the end of |
340 |
|
|
C<$data>. |
341 |
root |
1.1 |
|
342 |
root |
1.31 |
The C<$data> scalar I<MUST NOT> be modified in any way while the request |
343 |
root |
1.108 |
is outstanding. Modifying it can result in segfaults or World War III (if |
344 |
|
|
the necessary/optional hardware is installed). |
345 |
root |
1.31 |
|
346 |
root |
1.17 |
Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at |
347 |
root |
1.1 |
offset C<0> within the scalar: |
348 |
|
|
|
349 |
|
|
aio_read $fh, 7, 15, $buffer, 0, sub { |
350 |
root |
1.9 |
$_[0] > 0 or die "read error: $!"; |
351 |
|
|
print "read $_[0] bytes: <$buffer>\n"; |
352 |
root |
1.1 |
}; |
353 |
|
|
|
354 |
root |
1.106 |
|
355 |
root |
1.40 |
=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
356 |
root |
1.35 |
|
357 |
|
|
Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts |
358 |
|
|
reading at byte offset C<$in_offset>, and starts writing at the current |
359 |
|
|
file offset of C<$out_fh>. Because of that, it is not safe to issue more |
360 |
|
|
than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each |
361 |
|
|
other. |
362 |
|
|
|
363 |
|
|
This call tries to make use of a native C<sendfile> syscall to provide |
364 |
|
|
zero-copy operation. For this to work, C<$out_fh> should refer to a |
365 |
|
|
socket, and C<$in_fh> should refer to mmap'able file. |
366 |
|
|
|
367 |
|
|
If the native sendfile call fails or is not implemented, it will be |
368 |
root |
1.36 |
emulated, so you can call C<aio_sendfile> on any type of filehandle |
369 |
|
|
regardless of the limitations of the operating system. |
370 |
root |
1.35 |
|
371 |
|
|
Please note, however, that C<aio_sendfile> can read more bytes from |
372 |
|
|
C<$in_fh> than are written, and there is no way to find out how many |
373 |
root |
1.36 |
bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only |
374 |
|
|
provides the number of bytes written to C<$out_fh>. Only if the result |
375 |
|
|
value equals C<$length> one can assume that C<$length> bytes have been |
376 |
|
|
read. |
377 |
root |
1.35 |
|
378 |
root |
1.106 |
|
379 |
root |
1.40 |
=item aio_readahead $fh,$offset,$length, $callback->($retval) |
380 |
root |
1.1 |
|
381 |
root |
1.20 |
C<aio_readahead> populates the page cache with data from a file so that |
382 |
root |
1.1 |
subsequent reads from that file will not block on disk I/O. The C<$offset> |
383 |
|
|
argument specifies the starting point from which data is to be read and |
384 |
|
|
C<$length> specifies the number of bytes to be read. I/O is performed in |
385 |
|
|
whole pages, so that offset is effectively rounded down to a page boundary |
386 |
|
|
and bytes are read up to the next page boundary greater than or equal to |
387 |
root |
1.20 |
(off-set+length). C<aio_readahead> does not read beyond the end of the |
388 |
root |
1.1 |
file. The current file offset of the file is left unchanged. |
389 |
|
|
|
390 |
root |
1.26 |
If that syscall doesn't exist (likely if your OS isn't Linux) it will be |
391 |
|
|
emulated by simply reading the data, which would have a similar effect. |
392 |
|
|
|
393 |
root |
1.106 |
|
394 |
root |
1.40 |
=item aio_stat $fh_or_path, $callback->($status) |
395 |
root |
1.1 |
|
396 |
root |
1.40 |
=item aio_lstat $fh, $callback->($status) |
397 |
root |
1.1 |
|
398 |
|
|
Works like perl's C<stat> or C<lstat> in void context. The callback will |
399 |
|
|
be called after the stat and the results will be available using C<stat _> |
400 |
|
|
or C<-s _> etc... |
401 |
|
|
|
402 |
|
|
The pathname passed to C<aio_stat> must be absolute. See API NOTES, above, |
403 |
|
|
for an explanation. |
404 |
|
|
|
405 |
|
|
Currently, the stats are always 64-bit-stats, i.e. instead of returning an |
406 |
|
|
error when stat'ing a large file, the results will be silently truncated |
407 |
|
|
unless perl itself is compiled with large file support. |
408 |
|
|
|
409 |
|
|
Example: Print the length of F</etc/passwd>: |
410 |
|
|
|
411 |
|
|
aio_stat "/etc/passwd", sub { |
412 |
|
|
$_[0] and die "stat failed: $!"; |
413 |
|
|
print "size is ", -s _, "\n"; |
414 |
|
|
}; |
415 |
|
|
|
416 |
root |
1.106 |
|
417 |
|
|
=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
418 |
|
|
|
419 |
|
|
Works like perl's C<utime> function (including the special case of $atime |
420 |
|
|
and $mtime being undef). Fractional times are supported if the underlying |
421 |
|
|
syscalls support them. |
422 |
|
|
|
423 |
|
|
When called with a pathname, uses utimes(2) if available, otherwise |
424 |
|
|
utime(2). If called on a file descriptor, uses futimes(2) if available, |
425 |
|
|
otherwise returns ENOSYS, so this is not portable. |
426 |
|
|
|
427 |
|
|
Examples: |
428 |
|
|
|
429 |
root |
1.107 |
# set atime and mtime to current time (basically touch(1)): |
430 |
root |
1.106 |
aio_utime "path", undef, undef; |
431 |
|
|
# set atime to current time and mtime to beginning of the epoch: |
432 |
|
|
aio_utime "path", time, undef; # undef==0 |
433 |
|
|
|
434 |
|
|
|
435 |
|
|
=item aio_chown $fh_or_path, $uid, $gid, $callback->($status) |
436 |
|
|
|
437 |
|
|
Works like perl's C<chown> function, except that C<undef> for either $uid |
438 |
|
|
or $gid is being interpreted as "do not change" (but -1 can also be used). |
439 |
|
|
|
440 |
|
|
Examples: |
441 |
|
|
|
442 |
|
|
# same as "chown root path" in the shell: |
443 |
|
|
aio_chown "path", 0, -1; |
444 |
|
|
# same as above: |
445 |
|
|
aio_chown "path", 0, undef; |
446 |
|
|
|
447 |
|
|
|
448 |
|
|
=item aio_chmod $fh_or_path, $mode, $callback->($status) |
449 |
|
|
|
450 |
|
|
Works like perl's C<chmod> function. |
451 |
|
|
|
452 |
|
|
|
453 |
root |
1.40 |
=item aio_unlink $pathname, $callback->($status) |
454 |
root |
1.1 |
|
455 |
|
|
Asynchronously unlink (delete) a file and call the callback with the |
456 |
|
|
result code. |
457 |
|
|
|
458 |
root |
1.106 |
|
459 |
root |
1.82 |
=item aio_mknod $path, $mode, $dev, $callback->($status) |
460 |
|
|
|
461 |
root |
1.86 |
[EXPERIMENTAL] |
462 |
|
|
|
463 |
root |
1.83 |
Asynchronously create a device node (or fifo). See mknod(2). |
464 |
|
|
|
465 |
root |
1.86 |
The only (POSIX-) portable way of calling this function is: |
466 |
root |
1.83 |
|
467 |
|
|
aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... |
468 |
root |
1.82 |
|
469 |
root |
1.106 |
|
470 |
root |
1.50 |
=item aio_link $srcpath, $dstpath, $callback->($status) |
471 |
|
|
|
472 |
|
|
Asynchronously create a new link to the existing object at C<$srcpath> at |
473 |
|
|
the path C<$dstpath> and call the callback with the result code. |
474 |
|
|
|
475 |
root |
1.106 |
|
476 |
root |
1.50 |
=item aio_symlink $srcpath, $dstpath, $callback->($status) |
477 |
|
|
|
478 |
|
|
Asynchronously create a new symbolic link to the existing object at C<$srcpath> at |
479 |
|
|
the path C<$dstpath> and call the callback with the result code. |
480 |
|
|
|
481 |
root |
1.106 |
|
482 |
root |
1.90 |
=item aio_readlink $path, $callback->($link) |
483 |
|
|
|
484 |
|
|
Asynchronously read the symlink specified by C<$path> and pass it to |
485 |
|
|
the callback. If an error occurs, nothing or undef gets passed to the |
486 |
|
|
callback. |
487 |
|
|
|
488 |
root |
1.106 |
|
489 |
root |
1.50 |
=item aio_rename $srcpath, $dstpath, $callback->($status) |
490 |
|
|
|
491 |
|
|
Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as |
492 |
|
|
rename(2) and call the callback with the result code. |
493 |
|
|
|
494 |
root |
1.106 |
|
495 |
root |
1.101 |
=item aio_mkdir $pathname, $mode, $callback->($status) |
496 |
|
|
|
497 |
|
|
Asynchronously mkdir (create) a directory and call the callback with |
498 |
|
|
the result code. C<$mode> will be modified by the umask at the time the |
499 |
|
|
request is executed, so do not change your umask. |
500 |
|
|
|
501 |
root |
1.106 |
|
502 |
root |
1.40 |
=item aio_rmdir $pathname, $callback->($status) |
503 |
root |
1.27 |
|
504 |
|
|
Asynchronously rmdir (delete) a directory and call the callback with the |
505 |
|
|
result code. |
506 |
|
|
|
507 |
root |
1.106 |
|
508 |
root |
1.46 |
=item aio_readdir $pathname, $callback->($entries) |
509 |
root |
1.37 |
|
510 |
|
|
Unlike the POSIX call of the same name, C<aio_readdir> reads an entire |
511 |
|
|
directory (i.e. opendir + readdir + closedir). The entries will not be |
512 |
|
|
sorted, and will B<NOT> include the C<.> and C<..> entries. |
513 |
|
|
|
514 |
|
|
The callback a single argument which is either C<undef> or an array-ref |
515 |
|
|
with the filenames. |
516 |
|
|
|
517 |
root |
1.106 |
|
518 |
root |
1.98 |
=item aio_load $path, $data, $callback->($status) |
519 |
|
|
|
520 |
|
|
This is a composite request that tries to fully load the given file into |
521 |
|
|
memory. Status is the same as with aio_read. |
522 |
|
|
|
523 |
|
|
=cut |
524 |
|
|
|
525 |
|
|
sub aio_load($$;$) { |
526 |
|
|
aio_block { |
527 |
|
|
my ($path, undef, $cb) = @_; |
528 |
|
|
my $data = \$_[1]; |
529 |
|
|
|
530 |
|
|
my $pri = aioreq_pri; |
531 |
|
|
my $grp = aio_group $cb; |
532 |
|
|
|
533 |
|
|
aioreq_pri $pri; |
534 |
|
|
add $grp aio_open $path, O_RDONLY, 0, sub { |
535 |
root |
1.102 |
my $fh = shift |
536 |
root |
1.98 |
or return $grp->result (-1); |
537 |
|
|
|
538 |
|
|
aioreq_pri $pri; |
539 |
|
|
add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub { |
540 |
|
|
$grp->result ($_[0]); |
541 |
|
|
}; |
542 |
|
|
}; |
543 |
|
|
|
544 |
|
|
$grp |
545 |
|
|
} |
546 |
|
|
} |
547 |
|
|
|
548 |
root |
1.82 |
=item aio_copy $srcpath, $dstpath, $callback->($status) |
549 |
|
|
|
550 |
|
|
Try to copy the I<file> (directories not supported as either source or |
551 |
|
|
destination) from C<$srcpath> to C<$dstpath> and call the callback with |
552 |
|
|
the C<0> (error) or C<-1> ok. |
553 |
|
|
|
554 |
|
|
This is a composite request that it creates the destination file with |
555 |
|
|
mode 0200 and copies the contents of the source file into it using |
556 |
|
|
C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
557 |
|
|
uid/gid, in that order. |
558 |
|
|
|
559 |
|
|
If an error occurs, the partial destination file will be unlinked, if |
560 |
|
|
possible, except when setting atime, mtime, access mode and uid/gid, where |
561 |
|
|
errors are being ignored. |
562 |
|
|
|
563 |
|
|
=cut |
564 |
|
|
|
565 |
|
|
sub aio_copy($$;$) { |
566 |
root |
1.95 |
aio_block { |
567 |
|
|
my ($src, $dst, $cb) = @_; |
568 |
root |
1.82 |
|
569 |
root |
1.95 |
my $pri = aioreq_pri; |
570 |
|
|
my $grp = aio_group $cb; |
571 |
root |
1.82 |
|
572 |
root |
1.95 |
aioreq_pri $pri; |
573 |
|
|
add $grp aio_open $src, O_RDONLY, 0, sub { |
574 |
|
|
if (my $src_fh = $_[0]) { |
575 |
|
|
my @stat = stat $src_fh; |
576 |
|
|
|
577 |
|
|
aioreq_pri $pri; |
578 |
|
|
add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { |
579 |
|
|
if (my $dst_fh = $_[0]) { |
580 |
|
|
aioreq_pri $pri; |
581 |
|
|
add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { |
582 |
|
|
if ($_[0] == $stat[7]) { |
583 |
|
|
$grp->result (0); |
584 |
|
|
close $src_fh; |
585 |
|
|
|
586 |
|
|
# those should not normally block. should. should. |
587 |
|
|
utime $stat[8], $stat[9], $dst; |
588 |
|
|
chmod $stat[2] & 07777, $dst_fh; |
589 |
|
|
chown $stat[4], $stat[5], $dst_fh; |
590 |
|
|
close $dst_fh; |
591 |
|
|
} else { |
592 |
|
|
$grp->result (-1); |
593 |
|
|
close $src_fh; |
594 |
|
|
close $dst_fh; |
595 |
root |
1.82 |
|
596 |
root |
1.95 |
aioreq $pri; |
597 |
|
|
add $grp aio_unlink $dst; |
598 |
|
|
} |
599 |
|
|
}; |
600 |
|
|
} else { |
601 |
|
|
$grp->result (-1); |
602 |
|
|
} |
603 |
|
|
}, |
604 |
|
|
|
605 |
|
|
} else { |
606 |
|
|
$grp->result (-1); |
607 |
|
|
} |
608 |
|
|
}; |
609 |
root |
1.82 |
|
610 |
root |
1.95 |
$grp |
611 |
|
|
} |
612 |
root |
1.82 |
} |
613 |
|
|
|
614 |
|
|
=item aio_move $srcpath, $dstpath, $callback->($status) |
615 |
|
|
|
616 |
|
|
Try to move the I<file> (directories not supported as either source or |
617 |
|
|
destination) from C<$srcpath> to C<$dstpath> and call the callback with |
618 |
|
|
the C<0> (error) or C<-1> ok. |
619 |
|
|
|
620 |
|
|
This is a composite request that tries to rename(2) the file first. If |
621 |
|
|
rename files with C<EXDEV>, it copies the file with C<aio_copy> and, if |
622 |
|
|
that is successful, unlinking the C<$srcpath>. |
623 |
|
|
|
624 |
|
|
=cut |
625 |
|
|
|
626 |
|
|
sub aio_move($$;$) { |
627 |
root |
1.95 |
aio_block { |
628 |
|
|
my ($src, $dst, $cb) = @_; |
629 |
root |
1.82 |
|
630 |
root |
1.95 |
my $pri = aioreq_pri; |
631 |
|
|
my $grp = aio_group $cb; |
632 |
root |
1.82 |
|
633 |
root |
1.95 |
aioreq_pri $pri; |
634 |
|
|
add $grp aio_rename $src, $dst, sub { |
635 |
|
|
if ($_[0] && $! == EXDEV) { |
636 |
|
|
aioreq_pri $pri; |
637 |
|
|
add $grp aio_copy $src, $dst, sub { |
638 |
|
|
$grp->result ($_[0]); |
639 |
|
|
|
640 |
|
|
if (!$_[0]) { |
641 |
|
|
aioreq_pri $pri; |
642 |
|
|
add $grp aio_unlink $src; |
643 |
|
|
} |
644 |
|
|
}; |
645 |
|
|
} else { |
646 |
root |
1.82 |
$grp->result ($_[0]); |
647 |
root |
1.95 |
} |
648 |
|
|
}; |
649 |
root |
1.82 |
|
650 |
root |
1.95 |
$grp |
651 |
|
|
} |
652 |
root |
1.82 |
} |
653 |
|
|
|
654 |
root |
1.40 |
=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
655 |
|
|
|
656 |
root |
1.52 |
Scans a directory (similar to C<aio_readdir>) but additionally tries to |
657 |
root |
1.76 |
efficiently separate the entries of directory C<$path> into two sets of |
658 |
|
|
names, directories you can recurse into (directories), and ones you cannot |
659 |
|
|
recurse into (everything else, including symlinks to directories). |
660 |
root |
1.52 |
|
661 |
root |
1.61 |
C<aio_scandir> is a composite request that creates of many sub requests_ |
662 |
|
|
C<$maxreq> specifies the maximum number of outstanding aio requests that |
663 |
|
|
this function generates. If it is C<< <= 0 >>, then a suitable default |
664 |
root |
1.81 |
will be chosen (currently 4). |
665 |
root |
1.40 |
|
666 |
|
|
On error, the callback is called without arguments, otherwise it receives |
667 |
|
|
two array-refs with path-relative entry names. |
668 |
|
|
|
669 |
|
|
Example: |
670 |
|
|
|
671 |
|
|
aio_scandir $dir, 0, sub { |
672 |
|
|
my ($dirs, $nondirs) = @_; |
673 |
|
|
print "real directories: @$dirs\n"; |
674 |
|
|
print "everything else: @$nondirs\n"; |
675 |
|
|
}; |
676 |
|
|
|
677 |
|
|
Implementation notes. |
678 |
|
|
|
679 |
|
|
The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can. |
680 |
|
|
|
681 |
|
|
After reading the directory, the modification time, size etc. of the |
682 |
root |
1.52 |
directory before and after the readdir is checked, and if they match (and |
683 |
|
|
isn't the current time), the link count will be used to decide how many |
684 |
|
|
entries are directories (if >= 2). Otherwise, no knowledge of the number |
685 |
|
|
of subdirectories will be assumed. |
686 |
|
|
|
687 |
|
|
Then entries will be sorted into likely directories (everything without |
688 |
|
|
a non-initial dot currently) and likely non-directories (everything |
689 |
|
|
else). Then every entry plus an appended C</.> will be C<stat>'ed, |
690 |
|
|
likely directories first. If that succeeds, it assumes that the entry |
691 |
|
|
is a directory or a symlink to directory (which will be checked |
692 |
|
|
seperately). This is often faster than stat'ing the entry itself because |
693 |
|
|
filesystems might detect the type of the entry without reading the inode |
694 |
|
|
data (e.g. ext2fs filetype feature). |
695 |
|
|
|
696 |
|
|
If the known number of directories (link count - 2) has been reached, the |
697 |
|
|
rest of the entries is assumed to be non-directories. |
698 |
|
|
|
699 |
|
|
This only works with certainty on POSIX (= UNIX) filesystems, which |
700 |
|
|
fortunately are the vast majority of filesystems around. |
701 |
|
|
|
702 |
|
|
It will also likely work on non-POSIX filesystems with reduced efficiency |
703 |
|
|
as those tend to return 0 or 1 as link counts, which disables the |
704 |
|
|
directory counting heuristic. |
705 |
root |
1.40 |
|
706 |
|
|
=cut |
707 |
|
|
|
708 |
root |
1.100 |
sub aio_scandir($$;$) { |
709 |
root |
1.95 |
aio_block { |
710 |
|
|
my ($path, $maxreq, $cb) = @_; |
711 |
root |
1.40 |
|
712 |
root |
1.95 |
my $pri = aioreq_pri; |
713 |
root |
1.80 |
|
714 |
root |
1.95 |
my $grp = aio_group $cb; |
715 |
root |
1.55 |
|
716 |
root |
1.95 |
$maxreq = 4 if $maxreq <= 0; |
717 |
root |
1.40 |
|
718 |
root |
1.95 |
# stat once |
719 |
root |
1.80 |
aioreq_pri $pri; |
720 |
root |
1.95 |
add $grp aio_stat $path, sub { |
721 |
|
|
return $grp->result () if $_[0]; |
722 |
|
|
my $now = time; |
723 |
|
|
my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
724 |
root |
1.40 |
|
725 |
root |
1.95 |
# read the directory entries |
726 |
root |
1.80 |
aioreq_pri $pri; |
727 |
root |
1.95 |
add $grp aio_readdir $path, sub { |
728 |
|
|
my $entries = shift |
729 |
|
|
or return $grp->result (); |
730 |
|
|
|
731 |
|
|
# stat the dir another time |
732 |
|
|
aioreq_pri $pri; |
733 |
|
|
add $grp aio_stat $path, sub { |
734 |
|
|
my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
735 |
|
|
|
736 |
|
|
my $ndirs; |
737 |
|
|
|
738 |
|
|
# take the slow route if anything looks fishy |
739 |
|
|
if ($hash1 ne $hash2 or (stat _)[9] == $now) { |
740 |
|
|
$ndirs = -1; |
741 |
|
|
} else { |
742 |
|
|
# if nlink == 2, we are finished |
743 |
|
|
# on non-posix-fs's, we rely on nlink < 2 |
744 |
|
|
$ndirs = (stat _)[3] - 2 |
745 |
|
|
or return $grp->result ([], $entries); |
746 |
|
|
} |
747 |
|
|
|
748 |
|
|
# sort into likely dirs and likely nondirs |
749 |
|
|
# dirs == files without ".", short entries first |
750 |
|
|
$entries = [map $_->[0], |
751 |
|
|
sort { $b->[1] cmp $a->[1] } |
752 |
|
|
map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], |
753 |
|
|
@$entries]; |
754 |
root |
1.40 |
|
755 |
root |
1.95 |
my (@dirs, @nondirs); |
756 |
root |
1.40 |
|
757 |
root |
1.95 |
my $statgrp = add $grp aio_group sub { |
758 |
|
|
$grp->result (\@dirs, \@nondirs); |
759 |
|
|
}; |
760 |
root |
1.40 |
|
761 |
root |
1.95 |
limit $statgrp $maxreq; |
762 |
|
|
feed $statgrp sub { |
763 |
|
|
return unless @$entries; |
764 |
|
|
my $entry = pop @$entries; |
765 |
|
|
|
766 |
|
|
aioreq_pri $pri; |
767 |
|
|
add $statgrp aio_stat "$path/$entry/.", sub { |
768 |
|
|
if ($_[0] < 0) { |
769 |
|
|
push @nondirs, $entry; |
770 |
|
|
} else { |
771 |
|
|
# need to check for real directory |
772 |
|
|
aioreq_pri $pri; |
773 |
|
|
add $statgrp aio_lstat "$path/$entry", sub { |
774 |
|
|
if (-d _) { |
775 |
|
|
push @dirs, $entry; |
776 |
|
|
|
777 |
|
|
unless (--$ndirs) { |
778 |
|
|
push @nondirs, @$entries; |
779 |
|
|
feed $statgrp; |
780 |
|
|
} |
781 |
|
|
} else { |
782 |
|
|
push @nondirs, $entry; |
783 |
root |
1.74 |
} |
784 |
root |
1.40 |
} |
785 |
|
|
} |
786 |
root |
1.95 |
}; |
787 |
root |
1.74 |
}; |
788 |
root |
1.40 |
}; |
789 |
|
|
}; |
790 |
|
|
}; |
791 |
root |
1.55 |
|
792 |
root |
1.95 |
$grp |
793 |
|
|
} |
794 |
root |
1.40 |
} |
795 |
|
|
|
796 |
root |
1.99 |
=item aio_rmtree $path, $callback->($status) |
797 |
|
|
|
798 |
root |
1.100 |
Delete a directory tree starting (and including) C<$path>, return the |
799 |
|
|
status of the final C<rmdir> only. This is a composite request that |
800 |
|
|
uses C<aio_scandir> to recurse into and rmdir directories, and unlink |
801 |
|
|
everything else. |
802 |
root |
1.99 |
|
803 |
|
|
=cut |
804 |
|
|
|
805 |
|
|
sub aio_rmtree; |
806 |
root |
1.100 |
sub aio_rmtree($;$) { |
807 |
root |
1.99 |
aio_block { |
808 |
|
|
my ($path, $cb) = @_; |
809 |
|
|
|
810 |
|
|
my $pri = aioreq_pri; |
811 |
|
|
my $grp = aio_group $cb; |
812 |
|
|
|
813 |
|
|
aioreq_pri $pri; |
814 |
|
|
add $grp aio_scandir $path, 0, sub { |
815 |
|
|
my ($dirs, $nondirs) = @_; |
816 |
|
|
|
817 |
|
|
my $dirgrp = aio_group sub { |
818 |
|
|
add $grp aio_rmdir $path, sub { |
819 |
|
|
$grp->result ($_[0]); |
820 |
|
|
}; |
821 |
|
|
}; |
822 |
|
|
|
823 |
|
|
(aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs; |
824 |
|
|
(aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs; |
825 |
|
|
|
826 |
|
|
add $grp $dirgrp; |
827 |
|
|
}; |
828 |
|
|
|
829 |
|
|
$grp |
830 |
|
|
} |
831 |
|
|
} |
832 |
|
|
|
833 |
root |
1.40 |
=item aio_fsync $fh, $callback->($status) |
834 |
root |
1.1 |
|
835 |
|
|
Asynchronously call fsync on the given filehandle and call the callback |
836 |
|
|
with the fsync result code. |
837 |
|
|
|
838 |
root |
1.40 |
=item aio_fdatasync $fh, $callback->($status) |
839 |
root |
1.1 |
|
840 |
|
|
Asynchronously call fdatasync on the given filehandle and call the |
841 |
root |
1.26 |
callback with the fdatasync result code. |
842 |
|
|
|
843 |
|
|
If this call isn't available because your OS lacks it or it couldn't be |
844 |
|
|
detected, it will be emulated by calling C<fsync> instead. |
845 |
root |
1.1 |
|
846 |
root |
1.58 |
=item aio_group $callback->(...) |
847 |
root |
1.54 |
|
848 |
root |
1.55 |
This is a very special aio request: Instead of doing something, it is a |
849 |
|
|
container for other aio requests, which is useful if you want to bundle |
850 |
root |
1.71 |
many requests into a single, composite, request with a definite callback |
851 |
|
|
and the ability to cancel the whole request with its subrequests. |
852 |
root |
1.55 |
|
853 |
|
|
Returns an object of class L<IO::AIO::GRP>. See its documentation below |
854 |
|
|
for more info. |
855 |
|
|
|
856 |
|
|
Example: |
857 |
|
|
|
858 |
|
|
my $grp = aio_group sub { |
859 |
|
|
print "all stats done\n"; |
860 |
|
|
}; |
861 |
|
|
|
862 |
|
|
add $grp |
863 |
|
|
(aio_stat ...), |
864 |
|
|
(aio_stat ...), |
865 |
|
|
...; |
866 |
|
|
|
867 |
root |
1.63 |
=item aio_nop $callback->() |
868 |
|
|
|
869 |
|
|
This is a special request - it does nothing in itself and is only used for |
870 |
|
|
side effects, such as when you want to add a dummy request to a group so |
871 |
|
|
that finishing the requests in the group depends on executing the given |
872 |
|
|
code. |
873 |
|
|
|
874 |
root |
1.64 |
While this request does nothing, it still goes through the execution |
875 |
|
|
phase and still requires a worker thread. Thus, the callback will not |
876 |
|
|
be executed immediately but only after other requests in the queue have |
877 |
|
|
entered their execution phase. This can be used to measure request |
878 |
|
|
latency. |
879 |
|
|
|
880 |
root |
1.71 |
=item IO::AIO::aio_busy $fractional_seconds, $callback->() *NOT EXPORTED* |
881 |
root |
1.54 |
|
882 |
|
|
Mainly used for debugging and benchmarking, this aio request puts one of |
883 |
|
|
the request workers to sleep for the given time. |
884 |
|
|
|
885 |
root |
1.56 |
While it is theoretically handy to have simple I/O scheduling requests |
886 |
root |
1.71 |
like sleep and file handle readable/writable, the overhead this creates is |
887 |
|
|
immense (it blocks a thread for a long time) so do not use this function |
888 |
|
|
except to put your application under artificial I/O pressure. |
889 |
root |
1.56 |
|
890 |
root |
1.5 |
=back |
891 |
|
|
|
892 |
root |
1.53 |
=head2 IO::AIO::REQ CLASS |
893 |
root |
1.52 |
|
894 |
|
|
All non-aggregate C<aio_*> functions return an object of this class when |
895 |
|
|
called in non-void context. |
896 |
|
|
|
897 |
|
|
=over 4 |
898 |
|
|
|
899 |
root |
1.65 |
=item cancel $req |
900 |
root |
1.52 |
|
901 |
|
|
Cancels the request, if possible. Has the effect of skipping execution |
902 |
|
|
when entering the B<execute> state and skipping calling the callback when |
903 |
|
|
entering the the B<result> state, but will leave the request otherwise |
904 |
|
|
untouched. That means that requests that currently execute will not be |
905 |
|
|
stopped and resources held by the request will not be freed prematurely. |
906 |
|
|
|
907 |
root |
1.65 |
=item cb $req $callback->(...) |
908 |
|
|
|
909 |
|
|
Replace (or simply set) the callback registered to the request. |
910 |
|
|
|
911 |
root |
1.52 |
=back |
912 |
|
|
|
913 |
root |
1.55 |
=head2 IO::AIO::GRP CLASS |
914 |
|
|
|
915 |
|
|
This class is a subclass of L<IO::AIO::REQ>, so all its methods apply to |
916 |
|
|
objects of this class, too. |
917 |
|
|
|
918 |
|
|
A IO::AIO::GRP object is a special request that can contain multiple other |
919 |
|
|
aio requests. |
920 |
|
|
|
921 |
|
|
You create one by calling the C<aio_group> constructing function with a |
922 |
|
|
callback that will be called when all contained requests have entered the |
923 |
|
|
C<done> state: |
924 |
|
|
|
925 |
|
|
my $grp = aio_group sub { |
926 |
|
|
print "all requests are done\n"; |
927 |
|
|
}; |
928 |
|
|
|
929 |
|
|
You add requests by calling the C<add> method with one or more |
930 |
|
|
C<IO::AIO::REQ> objects: |
931 |
|
|
|
932 |
|
|
$grp->add (aio_unlink "..."); |
933 |
|
|
|
934 |
root |
1.58 |
add $grp aio_stat "...", sub { |
935 |
|
|
$_[0] or return $grp->result ("error"); |
936 |
|
|
|
937 |
|
|
# add another request dynamically, if first succeeded |
938 |
|
|
add $grp aio_open "...", sub { |
939 |
|
|
$grp->result ("ok"); |
940 |
|
|
}; |
941 |
|
|
}; |
942 |
root |
1.55 |
|
943 |
|
|
This makes it very easy to create composite requests (see the source of |
944 |
|
|
C<aio_move> for an application) that work and feel like simple requests. |
945 |
|
|
|
946 |
root |
1.62 |
=over 4 |
947 |
|
|
|
948 |
|
|
=item * The IO::AIO::GRP objects will be cleaned up during calls to |
949 |
root |
1.55 |
C<IO::AIO::poll_cb>, just like any other request. |
950 |
|
|
|
951 |
root |
1.62 |
=item * They can be canceled like any other request. Canceling will cancel not |
952 |
root |
1.59 |
only the request itself, but also all requests it contains. |
953 |
root |
1.55 |
|
954 |
root |
1.62 |
=item * They can also can also be added to other IO::AIO::GRP objects. |
955 |
root |
1.55 |
|
956 |
root |
1.62 |
=item * You must not add requests to a group from within the group callback (or |
957 |
root |
1.60 |
any later time). |
958 |
|
|
|
959 |
root |
1.62 |
=back |
960 |
|
|
|
961 |
root |
1.55 |
Their lifetime, simplified, looks like this: when they are empty, they |
962 |
|
|
will finish very quickly. If they contain only requests that are in the |
963 |
|
|
C<done> state, they will also finish. Otherwise they will continue to |
964 |
|
|
exist. |
965 |
|
|
|
966 |
root |
1.57 |
That means after creating a group you have some time to add requests. And |
967 |
|
|
in the callbacks of those requests, you can add further requests to the |
968 |
|
|
group. And only when all those requests have finished will the the group |
969 |
|
|
itself finish. |
970 |
|
|
|
971 |
root |
1.55 |
=over 4 |
972 |
|
|
|
973 |
root |
1.65 |
=item add $grp ... |
974 |
|
|
|
975 |
root |
1.55 |
=item $grp->add (...) |
976 |
|
|
|
977 |
root |
1.57 |
Add one or more requests to the group. Any type of L<IO::AIO::REQ> can |
978 |
|
|
be added, including other groups, as long as you do not create circular |
979 |
|
|
dependencies. |
980 |
|
|
|
981 |
|
|
Returns all its arguments. |
982 |
root |
1.55 |
|
983 |
root |
1.74 |
=item $grp->cancel_subs |
984 |
|
|
|
985 |
|
|
Cancel all subrequests and clears any feeder, but not the group request |
986 |
|
|
itself. Useful when you queued a lot of events but got a result early. |
987 |
|
|
|
988 |
root |
1.58 |
=item $grp->result (...) |
989 |
|
|
|
990 |
|
|
Set the result value(s) that will be passed to the group callback when all |
991 |
root |
1.80 |
subrequests have finished and set thre groups errno to the current value |
992 |
|
|
of errno (just like calling C<errno> without an error number). By default, |
993 |
|
|
no argument will be passed and errno is zero. |
994 |
|
|
|
995 |
|
|
=item $grp->errno ([$errno]) |
996 |
|
|
|
997 |
|
|
Sets the group errno value to C<$errno>, or the current value of errno |
998 |
|
|
when the argument is missing. |
999 |
|
|
|
1000 |
|
|
Every aio request has an associated errno value that is restored when |
1001 |
|
|
the callback is invoked. This method lets you change this value from its |
1002 |
|
|
default (0). |
1003 |
|
|
|
1004 |
|
|
Calling C<result> will also set errno, so make sure you either set C<$!> |
1005 |
|
|
before the call to C<result>, or call c<errno> after it. |
1006 |
root |
1.58 |
|
1007 |
root |
1.65 |
=item feed $grp $callback->($grp) |
1008 |
root |
1.60 |
|
1009 |
|
|
Sets a feeder/generator on this group: every group can have an attached |
1010 |
|
|
generator that generates requests if idle. The idea behind this is that, |
1011 |
|
|
although you could just queue as many requests as you want in a group, |
1012 |
|
|
this might starve other requests for a potentially long time. For |
1013 |
|
|
example, C<aio_scandir> might generate hundreds of thousands C<aio_stat> |
1014 |
|
|
requests, delaying any later requests for a long time. |
1015 |
|
|
|
1016 |
|
|
To avoid this, and allow incremental generation of requests, you can |
1017 |
|
|
instead a group and set a feeder on it that generates those requests. The |
1018 |
root |
1.68 |
feed callback will be called whenever there are few enough (see C<limit>, |
1019 |
root |
1.60 |
below) requests active in the group itself and is expected to queue more |
1020 |
|
|
requests. |
1021 |
|
|
|
1022 |
root |
1.68 |
The feed callback can queue as many requests as it likes (i.e. C<add> does |
1023 |
|
|
not impose any limits). |
1024 |
root |
1.60 |
|
1025 |
root |
1.65 |
If the feed does not queue more requests when called, it will be |
1026 |
root |
1.60 |
automatically removed from the group. |
1027 |
|
|
|
1028 |
root |
1.65 |
If the feed limit is C<0>, it will be set to C<2> automatically. |
1029 |
root |
1.60 |
|
1030 |
|
|
Example: |
1031 |
|
|
|
1032 |
|
|
# stat all files in @files, but only ever use four aio requests concurrently: |
1033 |
|
|
|
1034 |
|
|
my $grp = aio_group sub { print "finished\n" }; |
1035 |
root |
1.68 |
limit $grp 4; |
1036 |
root |
1.65 |
feed $grp sub { |
1037 |
root |
1.60 |
my $file = pop @files |
1038 |
|
|
or return; |
1039 |
|
|
|
1040 |
|
|
add $grp aio_stat $file, sub { ... }; |
1041 |
root |
1.65 |
}; |
1042 |
root |
1.60 |
|
1043 |
root |
1.68 |
=item limit $grp $num |
1044 |
root |
1.60 |
|
1045 |
|
|
Sets the feeder limit for the group: The feeder will be called whenever |
1046 |
|
|
the group contains less than this many requests. |
1047 |
|
|
|
1048 |
|
|
Setting the limit to C<0> will pause the feeding process. |
1049 |
|
|
|
1050 |
root |
1.55 |
=back |
1051 |
|
|
|
1052 |
root |
1.5 |
=head2 SUPPORT FUNCTIONS |
1053 |
|
|
|
1054 |
root |
1.86 |
=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION |
1055 |
|
|
|
1056 |
root |
1.5 |
=over 4 |
1057 |
|
|
|
1058 |
|
|
=item $fileno = IO::AIO::poll_fileno |
1059 |
|
|
|
1060 |
root |
1.20 |
Return the I<request result pipe file descriptor>. This filehandle must be |
1061 |
|
|
polled for reading by some mechanism outside this module (e.g. Event or |
1062 |
|
|
select, see below or the SYNOPSIS). If the pipe becomes readable you have |
1063 |
|
|
to call C<poll_cb> to check the results. |
1064 |
root |
1.5 |
|
1065 |
|
|
See C<poll_cb> for an example. |
1066 |
|
|
|
1067 |
|
|
=item IO::AIO::poll_cb |
1068 |
|
|
|
1069 |
root |
1.86 |
Process some outstanding events on the result pipe. You have to call this |
1070 |
root |
1.5 |
regularly. Returns the number of events processed. Returns immediately |
1071 |
root |
1.86 |
when no events are outstanding. The amount of events processed depends on |
1072 |
|
|
the settings of C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>. |
1073 |
root |
1.5 |
|
1074 |
root |
1.78 |
If not all requests were processed for whatever reason, the filehandle |
1075 |
|
|
will still be ready when C<poll_cb> returns. |
1076 |
|
|
|
1077 |
root |
1.20 |
Example: Install an Event watcher that automatically calls |
1078 |
|
|
IO::AIO::poll_cb with high priority: |
1079 |
root |
1.5 |
|
1080 |
|
|
Event->io (fd => IO::AIO::poll_fileno, |
1081 |
|
|
poll => 'r', async => 1, |
1082 |
|
|
cb => \&IO::AIO::poll_cb); |
1083 |
|
|
|
1084 |
root |
1.86 |
=item IO::AIO::max_poll_reqs $nreqs |
1085 |
|
|
|
1086 |
|
|
=item IO::AIO::max_poll_time $seconds |
1087 |
|
|
|
1088 |
|
|
These set the maximum number of requests (default C<0>, meaning infinity) |
1089 |
|
|
that are being processed by C<IO::AIO::poll_cb> in one call, respectively |
1090 |
|
|
the maximum amount of time (default C<0>, meaning infinity) spent in |
1091 |
|
|
C<IO::AIO::poll_cb> to process requests (more correctly the mininum amount |
1092 |
|
|
of time C<poll_cb> is allowed to use). |
1093 |
root |
1.78 |
|
1094 |
root |
1.89 |
Setting C<max_poll_time> to a non-zero value creates an overhead of one |
1095 |
|
|
syscall per request processed, which is not normally a problem unless your |
1096 |
|
|
callbacks are really really fast or your OS is really really slow (I am |
1097 |
|
|
not mentioning Solaris here). Using C<max_poll_reqs> incurs no overhead. |
1098 |
|
|
|
1099 |
root |
1.86 |
Setting these is useful if you want to ensure some level of |
1100 |
|
|
interactiveness when perl is not fast enough to process all requests in |
1101 |
|
|
time. |
1102 |
root |
1.78 |
|
1103 |
root |
1.86 |
For interactive programs, values such as C<0.01> to C<0.1> should be fine. |
1104 |
root |
1.78 |
|
1105 |
|
|
Example: Install an Event watcher that automatically calls |
1106 |
root |
1.89 |
IO::AIO::poll_cb with low priority, to ensure that other parts of the |
1107 |
root |
1.78 |
program get the CPU sometimes even under high AIO load. |
1108 |
|
|
|
1109 |
root |
1.86 |
# try not to spend much more than 0.1s in poll_cb |
1110 |
|
|
IO::AIO::max_poll_time 0.1; |
1111 |
|
|
|
1112 |
|
|
# use a low priority so other tasks have priority |
1113 |
root |
1.78 |
Event->io (fd => IO::AIO::poll_fileno, |
1114 |
|
|
poll => 'r', nice => 1, |
1115 |
root |
1.86 |
cb => &IO::AIO::poll_cb); |
1116 |
root |
1.78 |
|
1117 |
root |
1.5 |
=item IO::AIO::poll_wait |
1118 |
|
|
|
1119 |
root |
1.93 |
If there are any outstanding requests and none of them in the result |
1120 |
|
|
phase, wait till the result filehandle becomes ready for reading (simply |
1121 |
|
|
does a C<select> on the filehandle. This is useful if you want to |
1122 |
|
|
synchronously wait for some requests to finish). |
1123 |
root |
1.5 |
|
1124 |
|
|
See C<nreqs> for an example. |
1125 |
|
|
|
1126 |
root |
1.86 |
=item IO::AIO::poll |
1127 |
root |
1.5 |
|
1128 |
root |
1.86 |
Waits until some requests have been handled. |
1129 |
root |
1.5 |
|
1130 |
root |
1.92 |
Returns the number of requests processed, but is otherwise strictly |
1131 |
|
|
equivalent to: |
1132 |
root |
1.5 |
|
1133 |
|
|
IO::AIO::poll_wait, IO::AIO::poll_cb |
1134 |
root |
1.80 |
|
1135 |
root |
1.12 |
=item IO::AIO::flush |
1136 |
|
|
|
1137 |
|
|
Wait till all outstanding AIO requests have been handled. |
1138 |
|
|
|
1139 |
root |
1.13 |
Strictly equivalent to: |
1140 |
|
|
|
1141 |
|
|
IO::AIO::poll_wait, IO::AIO::poll_cb |
1142 |
|
|
while IO::AIO::nreqs; |
1143 |
|
|
|
1144 |
root |
1.104 |
=back |
1145 |
|
|
|
1146 |
root |
1.86 |
=head3 CONTROLLING THE NUMBER OF THREADS |
1147 |
root |
1.13 |
|
1148 |
root |
1.105 |
=over |
1149 |
|
|
|
1150 |
root |
1.5 |
=item IO::AIO::min_parallel $nthreads |
1151 |
|
|
|
1152 |
root |
1.61 |
Set the minimum number of AIO threads to C<$nthreads>. The current |
1153 |
|
|
default is C<8>, which means eight asynchronous operations can execute |
1154 |
|
|
concurrently at any one time (the number of outstanding requests, |
1155 |
|
|
however, is unlimited). |
1156 |
root |
1.5 |
|
1157 |
root |
1.34 |
IO::AIO starts threads only on demand, when an AIO request is queued and |
1158 |
root |
1.86 |
no free thread exists. Please note that queueing up a hundred requests can |
1159 |
|
|
create demand for a hundred threads, even if it turns out that everything |
1160 |
|
|
is in the cache and could have been processed faster by a single thread. |
1161 |
root |
1.34 |
|
1162 |
root |
1.61 |
It is recommended to keep the number of threads relatively low, as some |
1163 |
|
|
Linux kernel versions will scale negatively with the number of threads |
1164 |
|
|
(higher parallelity => MUCH higher latency). With current Linux 2.6 |
1165 |
|
|
versions, 4-32 threads should be fine. |
1166 |
root |
1.5 |
|
1167 |
root |
1.34 |
Under most circumstances you don't need to call this function, as the |
1168 |
|
|
module selects a default that is suitable for low to moderate load. |
1169 |
root |
1.5 |
|
1170 |
|
|
=item IO::AIO::max_parallel $nthreads |
1171 |
|
|
|
1172 |
root |
1.34 |
Sets the maximum number of AIO threads to C<$nthreads>. If more than the |
1173 |
|
|
specified number of threads are currently running, this function kills |
1174 |
|
|
them. This function blocks until the limit is reached. |
1175 |
|
|
|
1176 |
|
|
While C<$nthreads> are zero, aio requests get queued but not executed |
1177 |
|
|
until the number of threads has been increased again. |
1178 |
root |
1.5 |
|
1179 |
|
|
This module automatically runs C<max_parallel 0> at program end, to ensure |
1180 |
|
|
that all threads are killed and that there are no outstanding requests. |
1181 |
|
|
|
1182 |
|
|
Under normal circumstances you don't need to call this function. |
1183 |
|
|
|
1184 |
root |
1.86 |
=item IO::AIO::max_idle $nthreads |
1185 |
|
|
|
1186 |
|
|
Limit the number of threads (default: 4) that are allowed to idle (i.e., |
1187 |
|
|
threads that did not get a request to process within 10 seconds). That |
1188 |
|
|
means if a thread becomes idle while C<$nthreads> other threads are also |
1189 |
|
|
idle, it will free its resources and exit. |
1190 |
|
|
|
1191 |
|
|
This is useful when you allow a large number of threads (e.g. 100 or 1000) |
1192 |
|
|
to allow for extremely high load situations, but want to free resources |
1193 |
|
|
under normal circumstances (1000 threads can easily consume 30MB of RAM). |
1194 |
|
|
|
1195 |
|
|
The default is probably ok in most situations, especially if thread |
1196 |
|
|
creation is fast. If thread creation is very slow on your system you might |
1197 |
|
|
want to use larger values. |
1198 |
|
|
|
1199 |
root |
1.79 |
=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs |
1200 |
root |
1.5 |
|
1201 |
root |
1.79 |
This is a very bad function to use in interactive programs because it |
1202 |
|
|
blocks, and a bad way to reduce concurrency because it is inexact: Better |
1203 |
|
|
use an C<aio_group> together with a feed callback. |
1204 |
|
|
|
1205 |
|
|
Sets the maximum number of outstanding requests to C<$nreqs>. If you |
1206 |
|
|
to queue up more than this number of requests, the next call to the |
1207 |
|
|
C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>) |
1208 |
|
|
function will block until the limit is no longer exceeded. |
1209 |
|
|
|
1210 |
|
|
The default value is very large, so there is no practical limit on the |
1211 |
|
|
number of outstanding requests. |
1212 |
|
|
|
1213 |
|
|
You can still queue as many requests as you want. Therefore, |
1214 |
|
|
C<max_oustsanding> is mainly useful in simple scripts (with low values) or |
1215 |
|
|
as a stop gap to shield against fatal memory overflow (with large values). |
1216 |
root |
1.5 |
|
1217 |
root |
1.104 |
=back |
1218 |
|
|
|
1219 |
root |
1.86 |
=head3 STATISTICAL INFORMATION |
1220 |
|
|
|
1221 |
root |
1.104 |
=over |
1222 |
|
|
|
1223 |
root |
1.86 |
=item IO::AIO::nreqs |
1224 |
|
|
|
1225 |
|
|
Returns the number of requests currently in the ready, execute or pending |
1226 |
|
|
states (i.e. for which their callback has not been invoked yet). |
1227 |
|
|
|
1228 |
|
|
Example: wait till there are no outstanding requests anymore: |
1229 |
|
|
|
1230 |
|
|
IO::AIO::poll_wait, IO::AIO::poll_cb |
1231 |
|
|
while IO::AIO::nreqs; |
1232 |
|
|
|
1233 |
|
|
=item IO::AIO::nready |
1234 |
|
|
|
1235 |
|
|
Returns the number of requests currently in the ready state (not yet |
1236 |
|
|
executed). |
1237 |
|
|
|
1238 |
|
|
=item IO::AIO::npending |
1239 |
|
|
|
1240 |
|
|
Returns the number of requests currently in the pending state (executed, |
1241 |
|
|
but not yet processed by poll_cb). |
1242 |
|
|
|
1243 |
root |
1.5 |
=back |
1244 |
|
|
|
1245 |
root |
1.1 |
=cut |
1246 |
|
|
|
1247 |
root |
1.2 |
# support function to convert a fd into a perl filehandle |
1248 |
|
|
sub _fd2fh { |
1249 |
|
|
return undef if $_[0] < 0; |
1250 |
|
|
|
1251 |
root |
1.23 |
# try to generate nice filehandles |
1252 |
|
|
my $sym = "IO::AIO::fd#$_[0]"; |
1253 |
|
|
local *$sym; |
1254 |
root |
1.25 |
|
1255 |
root |
1.27 |
open *$sym, "+<&=$_[0]" # usually works under any unix |
1256 |
|
|
or open *$sym, "<&=$_[0]" # cygwin needs this |
1257 |
|
|
or open *$sym, ">&=$_[0]" # or this |
1258 |
root |
1.2 |
or return undef; |
1259 |
|
|
|
1260 |
root |
1.23 |
*$sym |
1261 |
root |
1.2 |
} |
1262 |
|
|
|
1263 |
root |
1.61 |
min_parallel 8; |
1264 |
root |
1.1 |
|
1265 |
root |
1.95 |
END { flush } |
1266 |
root |
1.82 |
|
1267 |
root |
1.1 |
1; |
1268 |
|
|
|
1269 |
root |
1.27 |
=head2 FORK BEHAVIOUR |
1270 |
|
|
|
1271 |
root |
1.52 |
This module should do "the right thing" when the process using it forks: |
1272 |
|
|
|
1273 |
root |
1.34 |
Before the fork, IO::AIO enters a quiescent state where no requests |
1274 |
|
|
can be added in other threads and no results will be processed. After |
1275 |
|
|
the fork the parent simply leaves the quiescent state and continues |
1276 |
root |
1.72 |
request/result processing, while the child frees the request/result queue |
1277 |
|
|
(so that the requests started before the fork will only be handled in the |
1278 |
|
|
parent). Threads will be started on demand until the limit set in the |
1279 |
root |
1.34 |
parent process has been reached again. |
1280 |
root |
1.27 |
|
1281 |
root |
1.52 |
In short: the parent will, after a short pause, continue as if fork had |
1282 |
|
|
not been called, while the child will act as if IO::AIO has not been used |
1283 |
|
|
yet. |
1284 |
|
|
|
1285 |
root |
1.60 |
=head2 MEMORY USAGE |
1286 |
|
|
|
1287 |
root |
1.72 |
Per-request usage: |
1288 |
|
|
|
1289 |
|
|
Each aio request uses - depending on your architecture - around 100-200 |
1290 |
|
|
bytes of memory. In addition, stat requests need a stat buffer (possibly |
1291 |
|
|
a few hundred bytes), readdir requires a result buffer and so on. Perl |
1292 |
|
|
scalars and other data passed into aio requests will also be locked and |
1293 |
|
|
will consume memory till the request has entered the done state. |
1294 |
root |
1.60 |
|
1295 |
|
|
This is now awfully much, so queuing lots of requests is not usually a |
1296 |
|
|
problem. |
1297 |
|
|
|
1298 |
root |
1.72 |
Per-thread usage: |
1299 |
|
|
|
1300 |
|
|
In the execution phase, some aio requests require more memory for |
1301 |
|
|
temporary buffers, and each thread requires a stack and other data |
1302 |
|
|
structures (usually around 16k-128k, depending on the OS). |
1303 |
|
|
|
1304 |
|
|
=head1 KNOWN BUGS |
1305 |
|
|
|
1306 |
root |
1.73 |
Known bugs will be fixed in the next release. |
1307 |
root |
1.60 |
|
1308 |
root |
1.1 |
=head1 SEE ALSO |
1309 |
|
|
|
1310 |
root |
1.68 |
L<Coro::AIO>. |
1311 |
root |
1.1 |
|
1312 |
|
|
=head1 AUTHOR |
1313 |
|
|
|
1314 |
|
|
Marc Lehmann <schmorp@schmorp.de> |
1315 |
|
|
http://home.schmorp.de/ |
1316 |
|
|
|
1317 |
|
|
=cut |
1318 |
|
|
|