… | |
… | |
50 | |
50 | |
51 | =head1 DESCRIPTION |
51 | =head1 DESCRIPTION |
52 | |
52 | |
53 | This module implements asynchronous I/O using whatever means your |
53 | This module implements asynchronous I/O using whatever means your |
54 | operating system supports. |
54 | operating system supports. |
|
|
55 | |
|
|
56 | Asynchronous means that operations that can normally block your program |
|
|
57 | (e.g. reading from disk) will be done asynchronously: the operation |
|
|
58 | will still block, but you can do something else in the meantime. This |
|
|
59 | is extremely useful for programs that need to stay interactive even |
|
|
60 | when doing heavy I/O (GUI programs, high performance network servers |
|
|
61 | etc.), but can also be used to easily do operations in parallel that are |
|
|
62 | normally done sequentially, e.g. stat'ing many files, which is much faster |
|
|
63 | on a RAID volume or over NFS when you do a number of stat operations |
|
|
64 | concurrently. |
|
|
65 | |
|
|
66 | While most of this works on all types of file descriptors (for example |
|
|
67 | sockets), using these functions on file descriptors that support |
|
|
68 | nonblocking operation (again, sockets, pipes etc.) is very inefficient or |
|
|
69 | might not work (aio_read fails on sockets/pipes/fifos). Use an event loop |
|
|
70 | for that (such as the L<Event|Event> module): IO::AIO will naturally fit |
|
|
71 | into such an event loop itself. |
55 | |
72 | |
56 | In this version, a number of threads are started that execute your |
73 | In this version, a number of threads are started that execute your |
57 | requests and signal their completion. You don't need thread support |
74 | requests and signal their completion. You don't need thread support |
58 | in perl, and the threads created by this module will not be visible |
75 | in perl, and the threads created by this module will not be visible |
59 | to perl. In the future, this module might make use of the native aio |
76 | to perl. In the future, this module might make use of the native aio |
60 | functions available on many operating systems. However, they are often |
77 | functions available on many operating systems. However, they are often |
61 | not well-supported or restricted (Linux doesn't allow them on normal |
78 | not well-supported or restricted (GNU/Linux doesn't allow them on normal |
62 | files currently, for example), and they would only support aio_read and |
79 | files currently, for example), and they would only support aio_read and |
63 | aio_write, so the remaining functionality would have to be implemented |
80 | aio_write, so the remaining functionality would have to be implemented |
64 | using threads anyway. |
81 | using threads anyway. |
65 | |
82 | |
66 | Although the module will work with in the presence of other (Perl-) |
83 | Although the module will work with in the presence of other (Perl-) |
67 | threads, it is currently not reentrant in any way, so use appropriate |
84 | threads, it is currently not reentrant in any way, so use appropriate |
68 | locking yourself, always call C<poll_cb> from within the same thread, or |
85 | locking yourself, always call C<poll_cb> from within the same thread, or |
69 | never call C<poll_cb> (or other C<aio_> functions) recursively. |
86 | never call C<poll_cb> (or other C<aio_> functions) recursively. |
70 | |
87 | |
|
|
88 | =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 | my $fh = $_[0] |
|
|
105 | 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 | |
71 | =head1 REQUEST ANATOMY AND LIFETIME |
132 | =head1 REQUEST ANATOMY AND LIFETIME |
72 | |
133 | |
73 | Every C<aio_*> function creates a request. which is a C data structure not |
134 | Every C<aio_*> function creates a request. which is a C data structure not |
74 | directly visible to Perl. |
135 | directly visible to Perl. |
75 | |
136 | |
… | |
… | |
116 | Request has reached the end of its lifetime and holds no resources anymore |
177 | Request has reached the end of its lifetime and holds no resources anymore |
117 | (except possibly for the Perl object, but its connection to the actual |
178 | (except possibly for the Perl object, but its connection to the actual |
118 | aio request is severed and calling its methods will either do nothing or |
179 | aio request is severed and calling its methods will either do nothing or |
119 | result in a runtime error). |
180 | result in a runtime error). |
120 | |
181 | |
|
|
182 | =back |
|
|
183 | |
121 | =cut |
184 | =cut |
122 | |
185 | |
123 | package IO::AIO; |
186 | package IO::AIO; |
124 | |
187 | |
125 | no warnings; |
188 | no warnings; |
126 | use strict 'vars'; |
189 | use strict 'vars'; |
127 | |
190 | |
128 | use base 'Exporter'; |
191 | use base 'Exporter'; |
129 | |
192 | |
130 | BEGIN { |
193 | BEGIN { |
131 | our $VERSION = '2.0'; |
194 | our $VERSION = '2.2'; |
132 | |
195 | |
133 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat |
196 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat |
134 | aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink |
197 | aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink |
135 | aio_fsync aio_fdatasync aio_readahead aio_rename aio_link aio_move |
198 | aio_readlink aio_fsync aio_fdatasync aio_readahead aio_rename aio_link |
136 | aio_group aio_nop); |
199 | aio_move aio_copy aio_group aio_nop aio_mknod); |
137 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
200 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
138 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
201 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
139 | min_parallel max_parallel max_outstanding nreqs); |
202 | min_parallel max_parallel max_idle |
|
|
203 | nreqs nready npending nthreads |
|
|
204 | max_poll_time max_poll_reqs); |
140 | |
205 | |
141 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
206 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
142 | |
207 | |
143 | require XSLoader; |
208 | require XSLoader; |
144 | XSLoader::load ("IO::AIO", $VERSION); |
209 | XSLoader::load ("IO::AIO", $VERSION); |
145 | } |
210 | } |
146 | |
211 | |
147 | =head1 FUNCTIONS |
212 | =head1 FUNCTIONS |
148 | |
213 | |
149 | =head2 AIO FUNCTIONS |
214 | =head2 AIO REQUEST FUNCTIONS |
150 | |
215 | |
151 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
216 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
152 | with the same name (sans C<aio_>). The arguments are similar or identical, |
217 | with the same name (sans C<aio_>). The arguments are similar or identical, |
153 | and they all accept an additional (and optional) C<$callback> argument |
218 | and they all accept an additional (and optional) C<$callback> argument |
154 | which must be a code reference. This code reference will get called with |
219 | which must be a code reference. This code reference will get called with |
… | |
… | |
157 | syscall has been executed asynchronously. |
222 | syscall has been executed asynchronously. |
158 | |
223 | |
159 | All functions expecting a filehandle keep a copy of the filehandle |
224 | All functions expecting a filehandle keep a copy of the filehandle |
160 | internally until the request has finished. |
225 | internally until the request has finished. |
161 | |
226 | |
162 | All requests return objects of type L<IO::AIO::REQ> that allow further |
227 | All functions return request objects of type L<IO::AIO::REQ> that allow |
163 | manipulation of those requests while they are in-flight. |
228 | further manipulation of those requests while they are in-flight. |
164 | |
229 | |
165 | The pathnames you pass to these routines I<must> be absolute and |
230 | The pathnames you pass to these routines I<must> be absolute and |
166 | encoded in byte form. The reason for the former is that at the time the |
231 | encoded as octets. The reason for the former is that at the time the |
167 | request is being executed, the current working directory could have |
232 | request is being executed, the current working directory could have |
168 | changed. Alternatively, you can make sure that you never change the |
233 | changed. Alternatively, you can make sure that you never change the |
169 | current working directory. |
234 | current working directory anywhere in the program and then use relative |
|
|
235 | paths. |
170 | |
236 | |
171 | To encode pathnames to byte form, either make sure you either: a) |
237 | To encode pathnames as octets, either make sure you either: a) always pass |
172 | always pass in filenames you got from outside (command line, readdir |
238 | in filenames you got from outside (command line, readdir etc.) without |
173 | etc.), b) are ASCII or ISO 8859-1, c) use the Encode module and encode |
239 | tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module and encode |
174 | your pathnames to the locale (or other) encoding in effect in the user |
240 | your pathnames to the locale (or other) encoding in effect in the user |
175 | environment, d) use Glib::filename_from_unicode on unicode filenames or e) |
241 | environment, d) use Glib::filename_from_unicode on unicode filenames or e) |
176 | use something else. |
242 | use something else to ensure your scalar has the correct contents. |
|
|
243 | |
|
|
244 | This works, btw. independent of the internal UTF-8 bit, which IO::AIO |
|
|
245 | handles correctly wether it is set or not. |
177 | |
246 | |
178 | =over 4 |
247 | =over 4 |
179 | |
248 | |
180 | =item aioreq_pri $pri |
249 | =item $prev_pri = aioreq_pri [$pri] |
181 | |
250 | |
182 | Sets the priority for the next aio request. The default priority |
251 | Returns the priority value that would be used for the next request and, if |
|
|
252 | C<$pri> is given, sets the priority for the next aio request. |
|
|
253 | |
183 | is C<0>, the minimum and maximum priorities are C<-4> and C<4>, |
254 | The default priority is C<0>, the minimum and maximum priorities are C<-4> |
184 | respectively. Requests with higher priority will be serviced first. |
255 | and C<4>, respectively. Requests with higher priority will be serviced |
|
|
256 | first. |
185 | |
257 | |
186 | The priority will be reset to C<0> after each call to one of the C<aio_> |
258 | The priority will be reset to C<0> after each call to one of the C<aio_*> |
187 | functions. |
259 | functions. |
188 | |
260 | |
189 | Example: open a file with low priority, then read something from it with |
261 | Example: open a file with low priority, then read something from it with |
190 | higher priority so the read request is serviced before other low priority |
262 | higher priority so the read request is serviced before other low priority |
191 | open requests (potentially spamming the cache): |
263 | open requests (potentially spamming the cache): |
… | |
… | |
201 | }; |
273 | }; |
202 | |
274 | |
203 | =item aioreq_nice $pri_adjust |
275 | =item aioreq_nice $pri_adjust |
204 | |
276 | |
205 | Similar to C<aioreq_pri>, but subtracts the given value from the current |
277 | Similar to C<aioreq_pri>, but subtracts the given value from the current |
206 | priority, so effects are cumulative. |
278 | priority, so the effect is cumulative. |
207 | |
279 | |
208 | =item aio_open $pathname, $flags, $mode, $callback->($fh) |
280 | =item aio_open $pathname, $flags, $mode, $callback->($fh) |
209 | |
281 | |
210 | Asynchronously open or create a file and call the callback with a newly |
282 | Asynchronously open or create a file and call the callback with a newly |
211 | created filehandle for the file. |
283 | created filehandle for the file. |
… | |
… | |
261 | |
333 | |
262 | aio_read $fh, 7, 15, $buffer, 0, sub { |
334 | aio_read $fh, 7, 15, $buffer, 0, sub { |
263 | $_[0] > 0 or die "read error: $!"; |
335 | $_[0] > 0 or die "read error: $!"; |
264 | print "read $_[0] bytes: <$buffer>\n"; |
336 | print "read $_[0] bytes: <$buffer>\n"; |
265 | }; |
337 | }; |
266 | |
|
|
267 | =item aio_move $srcpath, $dstpath, $callback->($status) |
|
|
268 | |
|
|
269 | Try to move the I<file> (directories not supported as either source or |
|
|
270 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
|
|
271 | the C<0> (error) or C<-1> ok. |
|
|
272 | |
|
|
273 | This is a composite request that tries to rename(2) the file first. If |
|
|
274 | rename files with C<EXDEV>, it creates the destination file with mode 0200 |
|
|
275 | and copies the contents of the source file into it using C<aio_sendfile>, |
|
|
276 | followed by restoring atime, mtime, access mode and uid/gid, in that |
|
|
277 | order, and unlinking the C<$srcpath>. |
|
|
278 | |
|
|
279 | If an error occurs, the partial destination file will be unlinked, if |
|
|
280 | possible, except when setting atime, mtime, access mode and uid/gid, where |
|
|
281 | errors are being ignored. |
|
|
282 | |
|
|
283 | =cut |
|
|
284 | |
|
|
285 | sub aio_move($$$) { |
|
|
286 | my ($src, $dst, $cb) = @_; |
|
|
287 | |
|
|
288 | my $grp = aio_group $cb; |
|
|
289 | |
|
|
290 | add $grp aio_rename $src, $dst, sub { |
|
|
291 | if ($_[0] && $! == EXDEV) { |
|
|
292 | add $grp aio_open $src, O_RDONLY, 0, sub { |
|
|
293 | if (my $src_fh = $_[0]) { |
|
|
294 | my @stat = stat $src_fh; |
|
|
295 | |
|
|
296 | add $grp aio_open $dst, O_WRONLY, 0200, sub { |
|
|
297 | if (my $dst_fh = $_[0]) { |
|
|
298 | add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { |
|
|
299 | close $src_fh; |
|
|
300 | |
|
|
301 | if ($_[0] == $stat[7]) { |
|
|
302 | utime $stat[8], $stat[9], $dst; |
|
|
303 | chmod $stat[2] & 07777, $dst_fh; |
|
|
304 | chown $stat[4], $stat[5], $dst_fh; |
|
|
305 | close $dst_fh; |
|
|
306 | |
|
|
307 | add $grp aio_unlink $src, sub { |
|
|
308 | $grp->result ($_[0]); |
|
|
309 | }; |
|
|
310 | } else { |
|
|
311 | my $errno = $!; |
|
|
312 | add $grp aio_unlink $dst, sub { |
|
|
313 | $! = $errno; |
|
|
314 | $grp->result (-1); |
|
|
315 | }; |
|
|
316 | } |
|
|
317 | }; |
|
|
318 | } else { |
|
|
319 | $grp->result (-1); |
|
|
320 | } |
|
|
321 | }, |
|
|
322 | |
|
|
323 | } else { |
|
|
324 | $grp->result (-1); |
|
|
325 | } |
|
|
326 | }; |
|
|
327 | } else { |
|
|
328 | $grp->result ($_[0]); |
|
|
329 | } |
|
|
330 | }; |
|
|
331 | |
|
|
332 | $grp |
|
|
333 | } |
|
|
334 | |
338 | |
335 | =item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
339 | =item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
336 | |
340 | |
337 | Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts |
341 | Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts |
338 | reading at byte offset C<$in_offset>, and starts writing at the current |
342 | reading at byte offset C<$in_offset>, and starts writing at the current |
… | |
… | |
394 | =item aio_unlink $pathname, $callback->($status) |
398 | =item aio_unlink $pathname, $callback->($status) |
395 | |
399 | |
396 | Asynchronously unlink (delete) a file and call the callback with the |
400 | Asynchronously unlink (delete) a file and call the callback with the |
397 | result code. |
401 | result code. |
398 | |
402 | |
|
|
403 | =item aio_mknod $path, $mode, $dev, $callback->($status) |
|
|
404 | |
|
|
405 | [EXPERIMENTAL] |
|
|
406 | |
|
|
407 | Asynchronously create a device node (or fifo). See mknod(2). |
|
|
408 | |
|
|
409 | The only (POSIX-) portable way of calling this function is: |
|
|
410 | |
|
|
411 | aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... |
|
|
412 | |
399 | =item aio_link $srcpath, $dstpath, $callback->($status) |
413 | =item aio_link $srcpath, $dstpath, $callback->($status) |
400 | |
414 | |
401 | Asynchronously create a new link to the existing object at C<$srcpath> at |
415 | Asynchronously create a new link to the existing object at C<$srcpath> at |
402 | the path C<$dstpath> and call the callback with the result code. |
416 | the path C<$dstpath> and call the callback with the result code. |
403 | |
417 | |
404 | =item aio_symlink $srcpath, $dstpath, $callback->($status) |
418 | =item aio_symlink $srcpath, $dstpath, $callback->($status) |
405 | |
419 | |
406 | Asynchronously create a new symbolic link to the existing object at C<$srcpath> at |
420 | Asynchronously create a new symbolic link to the existing object at C<$srcpath> at |
407 | the path C<$dstpath> and call the callback with the result code. |
421 | the path C<$dstpath> and call the callback with the result code. |
|
|
422 | |
|
|
423 | =item aio_readlink $path, $callback->($link) |
|
|
424 | |
|
|
425 | Asynchronously read the symlink specified by C<$path> and pass it to |
|
|
426 | the callback. If an error occurs, nothing or undef gets passed to the |
|
|
427 | callback. |
408 | |
428 | |
409 | =item aio_rename $srcpath, $dstpath, $callback->($status) |
429 | =item aio_rename $srcpath, $dstpath, $callback->($status) |
410 | |
430 | |
411 | Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as |
431 | Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as |
412 | rename(2) and call the callback with the result code. |
432 | rename(2) and call the callback with the result code. |
… | |
… | |
423 | sorted, and will B<NOT> include the C<.> and C<..> entries. |
443 | sorted, and will B<NOT> include the C<.> and C<..> entries. |
424 | |
444 | |
425 | The callback a single argument which is either C<undef> or an array-ref |
445 | The callback a single argument which is either C<undef> or an array-ref |
426 | with the filenames. |
446 | with the filenames. |
427 | |
447 | |
|
|
448 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
|
|
449 | |
|
|
450 | Try to copy the I<file> (directories not supported as either source or |
|
|
451 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
|
|
452 | the C<0> (error) or C<-1> ok. |
|
|
453 | |
|
|
454 | This is a composite request that it creates the destination file with |
|
|
455 | mode 0200 and copies the contents of the source file into it using |
|
|
456 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
|
|
457 | uid/gid, in that order. |
|
|
458 | |
|
|
459 | If an error occurs, the partial destination file will be unlinked, if |
|
|
460 | possible, except when setting atime, mtime, access mode and uid/gid, where |
|
|
461 | errors are being ignored. |
|
|
462 | |
|
|
463 | =cut |
|
|
464 | |
|
|
465 | sub aio_copy($$;$) { |
|
|
466 | my ($src, $dst, $cb) = @_; |
|
|
467 | |
|
|
468 | my $pri = aioreq_pri; |
|
|
469 | my $grp = aio_group $cb; |
|
|
470 | |
|
|
471 | aioreq_pri $pri; |
|
|
472 | add $grp aio_open $src, O_RDONLY, 0, sub { |
|
|
473 | if (my $src_fh = $_[0]) { |
|
|
474 | my @stat = stat $src_fh; |
|
|
475 | |
|
|
476 | aioreq_pri $pri; |
|
|
477 | add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { |
|
|
478 | if (my $dst_fh = $_[0]) { |
|
|
479 | aioreq_pri $pri; |
|
|
480 | add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { |
|
|
481 | if ($_[0] == $stat[7]) { |
|
|
482 | $grp->result (0); |
|
|
483 | close $src_fh; |
|
|
484 | |
|
|
485 | # those should not normally block. should. should. |
|
|
486 | utime $stat[8], $stat[9], $dst; |
|
|
487 | chmod $stat[2] & 07777, $dst_fh; |
|
|
488 | chown $stat[4], $stat[5], $dst_fh; |
|
|
489 | close $dst_fh; |
|
|
490 | } else { |
|
|
491 | $grp->result (-1); |
|
|
492 | close $src_fh; |
|
|
493 | close $dst_fh; |
|
|
494 | |
|
|
495 | aioreq $pri; |
|
|
496 | add $grp aio_unlink $dst; |
|
|
497 | } |
|
|
498 | }; |
|
|
499 | } else { |
|
|
500 | $grp->result (-1); |
|
|
501 | } |
|
|
502 | }, |
|
|
503 | |
|
|
504 | } else { |
|
|
505 | $grp->result (-1); |
|
|
506 | } |
|
|
507 | }; |
|
|
508 | |
|
|
509 | $grp |
|
|
510 | } |
|
|
511 | |
|
|
512 | =item aio_move $srcpath, $dstpath, $callback->($status) |
|
|
513 | |
|
|
514 | Try to move the I<file> (directories not supported as either source or |
|
|
515 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
|
|
516 | the C<0> (error) or C<-1> ok. |
|
|
517 | |
|
|
518 | This is a composite request that tries to rename(2) the file first. If |
|
|
519 | rename files with C<EXDEV>, it copies the file with C<aio_copy> and, if |
|
|
520 | that is successful, unlinking the C<$srcpath>. |
|
|
521 | |
|
|
522 | =cut |
|
|
523 | |
|
|
524 | sub aio_move($$;$) { |
|
|
525 | my ($src, $dst, $cb) = @_; |
|
|
526 | |
|
|
527 | my $pri = aioreq_pri; |
|
|
528 | my $grp = aio_group $cb; |
|
|
529 | |
|
|
530 | aioreq_pri $pri; |
|
|
531 | add $grp aio_rename $src, $dst, sub { |
|
|
532 | if ($_[0] && $! == EXDEV) { |
|
|
533 | aioreq_pri $pri; |
|
|
534 | add $grp aio_copy $src, $dst, sub { |
|
|
535 | $grp->result ($_[0]); |
|
|
536 | |
|
|
537 | if (!$_[0]) { |
|
|
538 | aioreq_pri $pri; |
|
|
539 | add $grp aio_unlink $src; |
|
|
540 | } |
|
|
541 | }; |
|
|
542 | } else { |
|
|
543 | $grp->result ($_[0]); |
|
|
544 | } |
|
|
545 | }; |
|
|
546 | |
|
|
547 | $grp |
|
|
548 | } |
|
|
549 | |
428 | =item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
550 | =item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
429 | |
551 | |
430 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
552 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
431 | separate the entries of directory C<$path> into two sets of names, ones |
553 | efficiently separate the entries of directory C<$path> into two sets of |
432 | you can recurse into (directories or links to them), and ones you cannot |
554 | names, directories you can recurse into (directories), and ones you cannot |
433 | recurse into (everything else). |
555 | recurse into (everything else, including symlinks to directories). |
434 | |
556 | |
435 | C<aio_scandir> is a composite request that creates of many sub requests_ |
557 | C<aio_scandir> is a composite request that creates of many sub requests_ |
436 | C<$maxreq> specifies the maximum number of outstanding aio requests that |
558 | C<$maxreq> specifies the maximum number of outstanding aio requests that |
437 | this function generates. If it is C<< <= 0 >>, then a suitable default |
559 | this function generates. If it is C<< <= 0 >>, then a suitable default |
438 | will be chosen (currently 6). |
560 | will be chosen (currently 4). |
439 | |
561 | |
440 | On error, the callback is called without arguments, otherwise it receives |
562 | On error, the callback is called without arguments, otherwise it receives |
441 | two array-refs with path-relative entry names. |
563 | two array-refs with path-relative entry names. |
442 | |
564 | |
443 | Example: |
565 | Example: |
… | |
… | |
480 | =cut |
602 | =cut |
481 | |
603 | |
482 | sub aio_scandir($$$) { |
604 | sub aio_scandir($$$) { |
483 | my ($path, $maxreq, $cb) = @_; |
605 | my ($path, $maxreq, $cb) = @_; |
484 | |
606 | |
|
|
607 | my $pri = aioreq_pri; |
|
|
608 | |
485 | my $grp = aio_group $cb; |
609 | my $grp = aio_group $cb; |
486 | |
610 | |
487 | $maxreq = 6 if $maxreq <= 0; |
611 | $maxreq = 4 if $maxreq <= 0; |
488 | |
612 | |
489 | # stat once |
613 | # stat once |
|
|
614 | aioreq_pri $pri; |
490 | add $grp aio_stat $path, sub { |
615 | add $grp aio_stat $path, sub { |
491 | return $grp->result () if $_[0]; |
616 | return $grp->result () if $_[0]; |
492 | my $now = time; |
617 | my $now = time; |
493 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
618 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
494 | |
619 | |
495 | # read the directory entries |
620 | # read the directory entries |
|
|
621 | aioreq_pri $pri; |
496 | add $grp aio_readdir $path, sub { |
622 | add $grp aio_readdir $path, sub { |
497 | my $entries = shift |
623 | my $entries = shift |
498 | or return $grp->result (); |
624 | or return $grp->result (); |
499 | |
625 | |
500 | # stat the dir another time |
626 | # stat the dir another time |
|
|
627 | aioreq_pri $pri; |
501 | add $grp aio_stat $path, sub { |
628 | add $grp aio_stat $path, sub { |
502 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
629 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
503 | |
630 | |
504 | my $ndirs; |
631 | my $ndirs; |
505 | |
632 | |
… | |
… | |
529 | limit $statgrp $maxreq; |
656 | limit $statgrp $maxreq; |
530 | feed $statgrp sub { |
657 | feed $statgrp sub { |
531 | return unless @$entries; |
658 | return unless @$entries; |
532 | my $entry = pop @$entries; |
659 | my $entry = pop @$entries; |
533 | |
660 | |
|
|
661 | aioreq_pri $pri; |
534 | add $statgrp aio_stat "$path/$entry/.", sub { |
662 | add $statgrp aio_stat "$path/$entry/.", sub { |
535 | if ($_[0] < 0) { |
663 | if ($_[0] < 0) { |
536 | push @nondirs, $entry; |
664 | push @nondirs, $entry; |
537 | } else { |
665 | } else { |
538 | # need to check for real directory |
666 | # need to check for real directory |
|
|
667 | aioreq_pri $pri; |
539 | add $statgrp aio_lstat "$path/$entry", sub { |
668 | add $statgrp aio_lstat "$path/$entry", sub { |
540 | if (-d _) { |
669 | if (-d _) { |
541 | push @dirs, $entry; |
670 | push @dirs, $entry; |
542 | |
671 | |
543 | unless (--$ndirs) { |
672 | unless (--$ndirs) { |
… | |
… | |
682 | =item * They can also can also be added to other IO::AIO::GRP objects. |
811 | =item * They can also can also be added to other IO::AIO::GRP objects. |
683 | |
812 | |
684 | =item * You must not add requests to a group from within the group callback (or |
813 | =item * You must not add requests to a group from within the group callback (or |
685 | any later time). |
814 | any later time). |
686 | |
815 | |
687 | =item * This does not harmonise well with C<max_outstanding>, so best do |
|
|
688 | not combine C<aio_group> with it. Groups and feeders are recommended for |
|
|
689 | this kind of concurrency-limiting. |
|
|
690 | |
|
|
691 | =back |
816 | =back |
692 | |
817 | |
693 | Their lifetime, simplified, looks like this: when they are empty, they |
818 | Their lifetime, simplified, looks like this: when they are empty, they |
694 | will finish very quickly. If they contain only requests that are in the |
819 | will finish very quickly. If they contain only requests that are in the |
695 | C<done> state, they will also finish. Otherwise they will continue to |
820 | C<done> state, they will also finish. Otherwise they will continue to |
… | |
… | |
718 | itself. Useful when you queued a lot of events but got a result early. |
843 | itself. Useful when you queued a lot of events but got a result early. |
719 | |
844 | |
720 | =item $grp->result (...) |
845 | =item $grp->result (...) |
721 | |
846 | |
722 | Set the result value(s) that will be passed to the group callback when all |
847 | Set the result value(s) that will be passed to the group callback when all |
723 | subrequests have finished. By default, no argument will be passed. |
848 | subrequests have finished and set thre groups errno to the current value |
|
|
849 | of errno (just like calling C<errno> without an error number). By default, |
|
|
850 | no argument will be passed and errno is zero. |
|
|
851 | |
|
|
852 | =item $grp->errno ([$errno]) |
|
|
853 | |
|
|
854 | Sets the group errno value to C<$errno>, or the current value of errno |
|
|
855 | when the argument is missing. |
|
|
856 | |
|
|
857 | Every aio request has an associated errno value that is restored when |
|
|
858 | the callback is invoked. This method lets you change this value from its |
|
|
859 | default (0). |
|
|
860 | |
|
|
861 | Calling C<result> will also set errno, so make sure you either set C<$!> |
|
|
862 | before the call to C<result>, or call c<errno> after it. |
724 | |
863 | |
725 | =item feed $grp $callback->($grp) |
864 | =item feed $grp $callback->($grp) |
726 | |
865 | |
727 | Sets a feeder/generator on this group: every group can have an attached |
866 | Sets a feeder/generator on this group: every group can have an attached |
728 | generator that generates requests if idle. The idea behind this is that, |
867 | generator that generates requests if idle. The idea behind this is that, |
… | |
… | |
767 | |
906 | |
768 | =back |
907 | =back |
769 | |
908 | |
770 | =head2 SUPPORT FUNCTIONS |
909 | =head2 SUPPORT FUNCTIONS |
771 | |
910 | |
|
|
911 | =head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION |
|
|
912 | |
772 | =over 4 |
913 | =over 4 |
773 | |
914 | |
774 | =item $fileno = IO::AIO::poll_fileno |
915 | =item $fileno = IO::AIO::poll_fileno |
775 | |
916 | |
776 | Return the I<request result pipe file descriptor>. This filehandle must be |
917 | Return the I<request result pipe file descriptor>. This filehandle must be |
… | |
… | |
780 | |
921 | |
781 | See C<poll_cb> for an example. |
922 | See C<poll_cb> for an example. |
782 | |
923 | |
783 | =item IO::AIO::poll_cb |
924 | =item IO::AIO::poll_cb |
784 | |
925 | |
785 | Process all outstanding events on the result pipe. You have to call this |
926 | Process some outstanding events on the result pipe. You have to call this |
786 | regularly. Returns the number of events processed. Returns immediately |
927 | regularly. Returns the number of events processed. Returns immediately |
787 | when no events are outstanding. |
928 | when no events are outstanding. The amount of events processed depends on |
|
|
929 | the settings of C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>. |
|
|
930 | |
|
|
931 | If not all requests were processed for whatever reason, the filehandle |
|
|
932 | will still be ready when C<poll_cb> returns. |
788 | |
933 | |
789 | Example: Install an Event watcher that automatically calls |
934 | Example: Install an Event watcher that automatically calls |
790 | IO::AIO::poll_cb with high priority: |
935 | IO::AIO::poll_cb with high priority: |
791 | |
936 | |
792 | Event->io (fd => IO::AIO::poll_fileno, |
937 | Event->io (fd => IO::AIO::poll_fileno, |
793 | poll => 'r', async => 1, |
938 | poll => 'r', async => 1, |
794 | cb => \&IO::AIO::poll_cb); |
939 | cb => \&IO::AIO::poll_cb); |
795 | |
940 | |
|
|
941 | =item IO::AIO::max_poll_reqs $nreqs |
|
|
942 | |
|
|
943 | =item IO::AIO::max_poll_time $seconds |
|
|
944 | |
|
|
945 | These set the maximum number of requests (default C<0>, meaning infinity) |
|
|
946 | that are being processed by C<IO::AIO::poll_cb> in one call, respectively |
|
|
947 | the maximum amount of time (default C<0>, meaning infinity) spent in |
|
|
948 | C<IO::AIO::poll_cb> to process requests (more correctly the mininum amount |
|
|
949 | of time C<poll_cb> is allowed to use). |
|
|
950 | |
|
|
951 | Setting C<max_poll_time> to a non-zero value creates an overhead of one |
|
|
952 | syscall per request processed, which is not normally a problem unless your |
|
|
953 | callbacks are really really fast or your OS is really really slow (I am |
|
|
954 | not mentioning Solaris here). Using C<max_poll_reqs> incurs no overhead. |
|
|
955 | |
|
|
956 | Setting these is useful if you want to ensure some level of |
|
|
957 | interactiveness when perl is not fast enough to process all requests in |
|
|
958 | time. |
|
|
959 | |
|
|
960 | For interactive programs, values such as C<0.01> to C<0.1> should be fine. |
|
|
961 | |
|
|
962 | Example: Install an Event watcher that automatically calls |
|
|
963 | IO::AIO::poll_cb with low priority, to ensure that other parts of the |
|
|
964 | program get the CPU sometimes even under high AIO load. |
|
|
965 | |
|
|
966 | # try not to spend much more than 0.1s in poll_cb |
|
|
967 | IO::AIO::max_poll_time 0.1; |
|
|
968 | |
|
|
969 | # use a low priority so other tasks have priority |
|
|
970 | Event->io (fd => IO::AIO::poll_fileno, |
|
|
971 | poll => 'r', nice => 1, |
|
|
972 | cb => &IO::AIO::poll_cb); |
|
|
973 | |
796 | =item IO::AIO::poll_wait |
974 | =item IO::AIO::poll_wait |
797 | |
975 | |
798 | Wait till the result filehandle becomes ready for reading (simply does a |
976 | If there are any outstanding requests, wait till the result filehandle |
799 | C<select> on the filehandle. This is useful if you want to synchronously wait |
977 | becomes ready for reading (simply does a C<select> on the filehandle. This |
800 | for some requests to finish). |
978 | is useful if you want to synchronously wait for some requests to finish). |
801 | |
979 | |
802 | See C<nreqs> for an example. |
980 | See C<nreqs> for an example. |
803 | |
981 | |
|
|
982 | =item IO::AIO::poll |
|
|
983 | |
|
|
984 | Waits until some requests have been handled. |
|
|
985 | |
|
|
986 | Returns the number of requests processed, but is otherwise strictly |
|
|
987 | equivalent to: |
|
|
988 | |
|
|
989 | IO::AIO::poll_wait, IO::AIO::poll_cb |
|
|
990 | if IO::AIO::nreqs; |
|
|
991 | |
804 | =item IO::AIO::nreqs |
992 | =item IO::AIO::flush |
805 | |
993 | |
806 | Returns the number of requests currently outstanding (i.e. for which their |
994 | Wait till all outstanding AIO requests have been handled. |
807 | callback has not been invoked yet). |
|
|
808 | |
995 | |
809 | Example: wait till there are no outstanding requests anymore: |
996 | Strictly equivalent to: |
810 | |
997 | |
811 | IO::AIO::poll_wait, IO::AIO::poll_cb |
998 | IO::AIO::poll_wait, IO::AIO::poll_cb |
812 | while IO::AIO::nreqs; |
999 | while IO::AIO::nreqs; |
813 | |
1000 | |
814 | =item IO::AIO::flush |
1001 | =head3 CONTROLLING THE NUMBER OF THREADS |
815 | |
|
|
816 | Wait till all outstanding AIO requests have been handled. |
|
|
817 | |
|
|
818 | Strictly equivalent to: |
|
|
819 | |
|
|
820 | IO::AIO::poll_wait, IO::AIO::poll_cb |
|
|
821 | while IO::AIO::nreqs; |
|
|
822 | |
|
|
823 | =item IO::AIO::poll |
|
|
824 | |
|
|
825 | Waits until some requests have been handled. |
|
|
826 | |
|
|
827 | Strictly equivalent to: |
|
|
828 | |
|
|
829 | IO::AIO::poll_wait, IO::AIO::poll_cb |
|
|
830 | if IO::AIO::nreqs; |
|
|
831 | |
1002 | |
832 | =item IO::AIO::min_parallel $nthreads |
1003 | =item IO::AIO::min_parallel $nthreads |
833 | |
1004 | |
834 | Set the minimum number of AIO threads to C<$nthreads>. The current |
1005 | Set the minimum number of AIO threads to C<$nthreads>. The current |
835 | default is C<8>, which means eight asynchronous operations can execute |
1006 | default is C<8>, which means eight asynchronous operations can execute |
836 | concurrently at any one time (the number of outstanding requests, |
1007 | concurrently at any one time (the number of outstanding requests, |
837 | however, is unlimited). |
1008 | however, is unlimited). |
838 | |
1009 | |
839 | IO::AIO starts threads only on demand, when an AIO request is queued and |
1010 | IO::AIO starts threads only on demand, when an AIO request is queued and |
840 | no free thread exists. |
1011 | no free thread exists. Please note that queueing up a hundred requests can |
|
|
1012 | create demand for a hundred threads, even if it turns out that everything |
|
|
1013 | is in the cache and could have been processed faster by a single thread. |
841 | |
1014 | |
842 | It is recommended to keep the number of threads relatively low, as some |
1015 | It is recommended to keep the number of threads relatively low, as some |
843 | Linux kernel versions will scale negatively with the number of threads |
1016 | Linux kernel versions will scale negatively with the number of threads |
844 | (higher parallelity => MUCH higher latency). With current Linux 2.6 |
1017 | (higher parallelity => MUCH higher latency). With current Linux 2.6 |
845 | versions, 4-32 threads should be fine. |
1018 | versions, 4-32 threads should be fine. |
… | |
… | |
859 | This module automatically runs C<max_parallel 0> at program end, to ensure |
1032 | This module automatically runs C<max_parallel 0> at program end, to ensure |
860 | that all threads are killed and that there are no outstanding requests. |
1033 | that all threads are killed and that there are no outstanding requests. |
861 | |
1034 | |
862 | Under normal circumstances you don't need to call this function. |
1035 | Under normal circumstances you don't need to call this function. |
863 | |
1036 | |
|
|
1037 | =item IO::AIO::max_idle $nthreads |
|
|
1038 | |
|
|
1039 | Limit the number of threads (default: 4) that are allowed to idle (i.e., |
|
|
1040 | threads that did not get a request to process within 10 seconds). That |
|
|
1041 | means if a thread becomes idle while C<$nthreads> other threads are also |
|
|
1042 | idle, it will free its resources and exit. |
|
|
1043 | |
|
|
1044 | This is useful when you allow a large number of threads (e.g. 100 or 1000) |
|
|
1045 | to allow for extremely high load situations, but want to free resources |
|
|
1046 | under normal circumstances (1000 threads can easily consume 30MB of RAM). |
|
|
1047 | |
|
|
1048 | The default is probably ok in most situations, especially if thread |
|
|
1049 | creation is fast. If thread creation is very slow on your system you might |
|
|
1050 | want to use larger values. |
|
|
1051 | |
864 | =item $oldnreqs = IO::AIO::max_outstanding $nreqs |
1052 | =item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs |
865 | |
1053 | |
866 | [DEPRECATED] |
1054 | This is a very bad function to use in interactive programs because it |
|
|
1055 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
|
|
1056 | use an C<aio_group> together with a feed callback. |
867 | |
1057 | |
868 | Sets the maximum number of outstanding requests to C<$nreqs>. If you |
1058 | Sets the maximum number of outstanding requests to C<$nreqs>. If you |
869 | try to queue up more than this number of requests, the caller will block until |
1059 | to queue up more than this number of requests, the next call to the |
870 | some requests have been handled. |
1060 | C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>) |
|
|
1061 | function will block until the limit is no longer exceeded. |
871 | |
1062 | |
872 | The default is very large, so normally there is no practical limit. If you |
1063 | The default value is very large, so there is no practical limit on the |
873 | queue up many requests in a loop it often improves speed if you set |
1064 | number of outstanding requests. |
874 | this to a relatively low number, such as C<100>. |
|
|
875 | |
1065 | |
876 | This function does not work well together with C<aio_group>'s, and their |
1066 | You can still queue as many requests as you want. Therefore, |
877 | feeder interface is better suited to limiting concurrency, so do not use |
1067 | C<max_oustsanding> is mainly useful in simple scripts (with low values) or |
878 | this function. |
1068 | as a stop gap to shield against fatal memory overflow (with large values). |
879 | |
1069 | |
880 | Under normal circumstances you don't need to call this function. |
1070 | =head3 STATISTICAL INFORMATION |
|
|
1071 | |
|
|
1072 | =item IO::AIO::nreqs |
|
|
1073 | |
|
|
1074 | Returns the number of requests currently in the ready, execute or pending |
|
|
1075 | states (i.e. for which their callback has not been invoked yet). |
|
|
1076 | |
|
|
1077 | Example: wait till there are no outstanding requests anymore: |
|
|
1078 | |
|
|
1079 | IO::AIO::poll_wait, IO::AIO::poll_cb |
|
|
1080 | while IO::AIO::nreqs; |
|
|
1081 | |
|
|
1082 | =item IO::AIO::nready |
|
|
1083 | |
|
|
1084 | Returns the number of requests currently in the ready state (not yet |
|
|
1085 | executed). |
|
|
1086 | |
|
|
1087 | =item IO::AIO::npending |
|
|
1088 | |
|
|
1089 | Returns the number of requests currently in the pending state (executed, |
|
|
1090 | but not yet processed by poll_cb). |
881 | |
1091 | |
882 | =back |
1092 | =back |
883 | |
1093 | |
884 | =cut |
1094 | =cut |
885 | |
1095 | |
… | |
… | |
900 | } |
1110 | } |
901 | |
1111 | |
902 | min_parallel 8; |
1112 | min_parallel 8; |
903 | |
1113 | |
904 | END { |
1114 | END { |
905 | max_parallel 0; |
1115 | min_parallel 1; |
906 | } |
1116 | flush; |
|
|
1117 | }; |
907 | |
1118 | |
908 | 1; |
1119 | 1; |
909 | |
1120 | |
910 | =head2 FORK BEHAVIOUR |
1121 | =head2 FORK BEHAVIOUR |
911 | |
1122 | |