… | |
… | |
26 | $req->cancel; # cancel request if still in queue |
26 | $req->cancel; # cancel request if still in queue |
27 | |
27 | |
28 | my $grp = aio_group sub { print "all stats done\n" }; |
28 | my $grp = aio_group sub { print "all stats done\n" }; |
29 | add $grp aio_stat "..." for ...; |
29 | add $grp aio_stat "..." for ...; |
30 | |
30 | |
|
|
31 | # AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...) |
|
|
32 | use AnyEvent::AIO; |
|
|
33 | |
31 | # AnyEvent integration |
34 | # EV integration |
32 | open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!"; |
35 | my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; |
33 | my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb }); |
|
|
34 | |
36 | |
35 | # Event integration |
37 | # Event integration |
36 | Event->io (fd => IO::AIO::poll_fileno, |
38 | Event->io (fd => IO::AIO::poll_fileno, |
37 | poll => 'r', |
39 | poll => 'r', |
38 | cb => \&IO::AIO::poll_cb); |
40 | cb => \&IO::AIO::poll_cb); |
… | |
… | |
62 | etc.), but can also be used to easily do operations in parallel that are |
64 | 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 |
65 | 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 |
66 | on a RAID volume or over NFS when you do a number of stat operations |
65 | concurrently. |
67 | concurrently. |
66 | |
68 | |
67 | While most of this works on all types of file descriptors (for example |
69 | While most of this works on all types of file descriptors (for |
68 | sockets), using these functions on file descriptors that support |
70 | example sockets), using these functions on file descriptors that |
69 | nonblocking operation (again, sockets, pipes etc.) is very inefficient or |
71 | support nonblocking operation (again, sockets, pipes etc.) is very |
70 | might not work (aio_read fails on sockets/pipes/fifos). Use an event loop |
72 | inefficient. Use an event loop for that (such as the L<Event|Event> |
71 | for that (such as the L<Event|Event> module): IO::AIO will naturally fit |
73 | module): IO::AIO will naturally fit into such an event loop itself. |
72 | into such an event loop itself. |
|
|
73 | |
74 | |
74 | In this version, a number of threads are started that execute your |
75 | In this version, a number of threads are started that execute your |
75 | requests and signal their completion. You don't need thread support |
76 | requests and signal their completion. You don't need thread support |
76 | in perl, and the threads created by this module will not be visible |
77 | in perl, and the threads created by this module will not be visible |
77 | to perl. In the future, this module might make use of the native aio |
78 | to perl. In the future, this module might make use of the native aio |
… | |
… | |
79 | not well-supported or restricted (GNU/Linux doesn't allow them on normal |
80 | not well-supported or restricted (GNU/Linux doesn't allow them on normal |
80 | files currently, for example), and they would only support aio_read and |
81 | files currently, for example), and they would only support aio_read and |
81 | aio_write, so the remaining functionality would have to be implemented |
82 | aio_write, so the remaining functionality would have to be implemented |
82 | using threads anyway. |
83 | using threads anyway. |
83 | |
84 | |
84 | Although the module will work with in the presence of other (Perl-) |
85 | Although the module will work in the presence of other (Perl-) threads, |
85 | threads, it is currently not reentrant in any way, so use appropriate |
86 | it is currently not reentrant in any way, so use appropriate locking |
86 | locking yourself, always call C<poll_cb> from within the same thread, or |
87 | yourself, always call C<poll_cb> from within the same thread, or never |
87 | never call C<poll_cb> (or other C<aio_> functions) recursively. |
88 | call C<poll_cb> (or other C<aio_> functions) recursively. |
88 | |
89 | |
89 | =head2 EXAMPLE |
90 | =head2 EXAMPLE |
90 | |
91 | |
91 | This is a simple example that uses the Event module and loads |
92 | This is a simple example that uses the Event module and loads |
92 | F</etc/passwd> asynchronously: |
93 | F</etc/passwd> asynchronously: |
… | |
… | |
184 | |
185 | |
185 | =cut |
186 | =cut |
186 | |
187 | |
187 | package IO::AIO; |
188 | package IO::AIO; |
188 | |
189 | |
|
|
190 | use Carp (); |
|
|
191 | |
189 | no warnings; |
192 | no warnings; |
190 | use strict 'vars'; |
193 | use strict 'vars'; |
191 | |
194 | |
192 | use base 'Exporter'; |
195 | use base 'Exporter'; |
193 | |
196 | |
194 | BEGIN { |
197 | BEGIN { |
195 | our $VERSION = '2.33'; |
198 | our $VERSION = '3.18'; |
196 | |
199 | |
197 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat |
200 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close |
198 | aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink |
201 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir |
199 | aio_readlink aio_fsync aio_fdatasync aio_readahead aio_rename aio_link |
202 | aio_scandir aio_symlink aio_readlink aio_sync aio_fsync |
|
|
203 | aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead |
|
|
204 | aio_rename aio_link aio_move aio_copy aio_group |
200 | aio_move aio_copy aio_group aio_nop aio_mknod aio_load aio_rmtree aio_mkdir); |
205 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
|
|
206 | aio_chmod aio_utime aio_truncate); |
|
|
207 | |
201 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block)); |
208 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
202 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
209 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
203 | min_parallel max_parallel max_idle |
210 | min_parallel max_parallel max_idle |
204 | nreqs nready npending nthreads |
211 | nreqs nready npending nthreads |
205 | max_poll_time max_poll_reqs); |
212 | max_poll_time max_poll_reqs); |
|
|
213 | |
|
|
214 | push @AIO_REQ, qw(aio_busy); # not exported |
206 | |
215 | |
207 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
216 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
208 | |
217 | |
209 | require XSLoader; |
218 | require XSLoader; |
210 | XSLoader::load ("IO::AIO", $VERSION); |
219 | XSLoader::load ("IO::AIO", $VERSION); |
… | |
… | |
217 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
226 | 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, |
227 | with the same name (sans C<aio_>). The arguments are similar or identical, |
219 | and they all accept an additional (and optional) C<$callback> argument |
228 | 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 |
229 | 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 |
230 | 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 |
231 | perl, which usually delivers "false") as its sole argument after the given |
223 | syscall has been executed asynchronously. |
232 | syscall has been executed asynchronously. |
224 | |
233 | |
225 | All functions expecting a filehandle keep a copy of the filehandle |
234 | All functions expecting a filehandle keep a copy of the filehandle |
226 | internally until the request has finished. |
235 | internally until the request has finished. |
227 | |
236 | |
… | |
… | |
241 | your pathnames to the locale (or other) encoding in effect in the user |
250 | 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) |
251 | environment, d) use Glib::filename_from_unicode on unicode filenames or e) |
243 | use something else to ensure your scalar has the correct contents. |
252 | use something else to ensure your scalar has the correct contents. |
244 | |
253 | |
245 | This works, btw. independent of the internal UTF-8 bit, which IO::AIO |
254 | This works, btw. independent of the internal UTF-8 bit, which IO::AIO |
246 | handles correctly wether it is set or not. |
255 | handles correctly whether it is set or not. |
247 | |
256 | |
248 | =over 4 |
257 | =over 4 |
249 | |
258 | |
250 | =item $prev_pri = aioreq_pri [$pri] |
259 | =item $prev_pri = aioreq_pri [$pri] |
251 | |
260 | |
… | |
… | |
271 | aio_read $_[0], ..., sub { |
280 | aio_read $_[0], ..., sub { |
272 | ... |
281 | ... |
273 | }; |
282 | }; |
274 | }; |
283 | }; |
275 | |
284 | |
|
|
285 | |
276 | =item aioreq_nice $pri_adjust |
286 | =item aioreq_nice $pri_adjust |
277 | |
287 | |
278 | Similar to C<aioreq_pri>, but subtracts the given value from the current |
288 | Similar to C<aioreq_pri>, but subtracts the given value from the current |
279 | priority, so the effect is cumulative. |
289 | priority, so the effect is cumulative. |
|
|
290 | |
280 | |
291 | |
281 | =item aio_open $pathname, $flags, $mode, $callback->($fh) |
292 | =item aio_open $pathname, $flags, $mode, $callback->($fh) |
282 | |
293 | |
283 | Asynchronously open or create a file and call the callback with a newly |
294 | Asynchronously open or create a file and call the callback with a newly |
284 | created filehandle for the file. |
295 | created filehandle for the file. |
… | |
… | |
305 | } else { |
316 | } else { |
306 | die "open failed: $!\n"; |
317 | die "open failed: $!\n"; |
307 | } |
318 | } |
308 | }; |
319 | }; |
309 | |
320 | |
|
|
321 | |
310 | =item aio_close $fh, $callback->($status) |
322 | =item aio_close $fh, $callback->($status) |
311 | |
323 | |
312 | Asynchronously close a file and call the callback with the result |
324 | Asynchronously close a file and call the callback with the result |
313 | code. I<WARNING:> although accepted, you should not pass in a perl |
325 | code. |
314 | filehandle here, as perl will likely close the file descriptor another |
|
|
315 | time when the filehandle is destroyed. Normally, you can safely call perls |
|
|
316 | C<close> or just let filehandles go out of scope. |
|
|
317 | |
326 | |
318 | This is supposed to be a bug in the API, so that might change. It's |
327 | Unfortunately, you can't do this to perl. Perl I<insists> very strongly on |
319 | therefore best to avoid this function. |
328 | closing the file descriptor associated with the filehandle itself. |
|
|
329 | |
|
|
330 | Therefore, C<aio_close> will not close the filehandle - instead it will |
|
|
331 | use dup2 to overwrite the file descriptor with the write-end of a pipe |
|
|
332 | (the pipe fd will be created on demand and will be cached). |
|
|
333 | |
|
|
334 | Or in other words: the file descriptor will be closed, but it will not be |
|
|
335 | free for reuse until the perl filehandle is closed. |
|
|
336 | |
|
|
337 | =cut |
320 | |
338 | |
321 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
339 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
322 | |
340 | |
323 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
341 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
324 | |
342 | |
325 | Reads or writes C<length> bytes from the specified C<fh> and C<offset> |
343 | Reads or writes C<$length> bytes from the specified C<$fh> and C<$offset> |
326 | into the scalar given by C<data> and offset C<dataoffset> and calls the |
344 | into the scalar given by C<$data> and offset C<$dataoffset> and calls the |
327 | callback without the actual number of bytes read (or -1 on error, just |
345 | callback without the actual number of bytes read (or -1 on error, just |
328 | like the syscall). |
346 | like the syscall). |
329 | |
347 | |
|
|
348 | If C<$offset> is undefined, then the current file descriptor offset will |
|
|
349 | be used (and updated), otherwise the file descriptor offset will not be |
|
|
350 | changed by these calls. |
|
|
351 | |
|
|
352 | If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>. |
|
|
353 | |
|
|
354 | If C<$dataoffset> is less than zero, it will be counted from the end of |
|
|
355 | C<$data>. |
|
|
356 | |
330 | The C<$data> scalar I<MUST NOT> be modified in any way while the request |
357 | The C<$data> scalar I<MUST NOT> be modified in any way while the request |
331 | is outstanding. Modifying it can result in segfaults or WW3 (if the |
358 | is outstanding. Modifying it can result in segfaults or World War III (if |
332 | necessary/optional hardware is installed). |
359 | the necessary/optional hardware is installed). |
333 | |
360 | |
334 | Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at |
361 | Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at |
335 | offset C<0> within the scalar: |
362 | offset C<0> within the scalar: |
336 | |
363 | |
337 | aio_read $fh, 7, 15, $buffer, 0, sub { |
364 | aio_read $fh, 7, 15, $buffer, 0, sub { |
338 | $_[0] > 0 or die "read error: $!"; |
365 | $_[0] > 0 or die "read error: $!"; |
339 | print "read $_[0] bytes: <$buffer>\n"; |
366 | print "read $_[0] bytes: <$buffer>\n"; |
340 | }; |
367 | }; |
|
|
368 | |
341 | |
369 | |
342 | =item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
370 | =item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
343 | |
371 | |
344 | Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts |
372 | Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts |
345 | reading at byte offset C<$in_offset>, and starts writing at the current |
373 | reading at byte offset C<$in_offset>, and starts writing at the current |
… | |
… | |
359 | C<$in_fh> than are written, and there is no way to find out how many |
387 | C<$in_fh> than are written, and there is no way to find out how many |
360 | bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only |
388 | bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only |
361 | provides the number of bytes written to C<$out_fh>. Only if the result |
389 | provides the number of bytes written to C<$out_fh>. Only if the result |
362 | value equals C<$length> one can assume that C<$length> bytes have been |
390 | value equals C<$length> one can assume that C<$length> bytes have been |
363 | read. |
391 | read. |
|
|
392 | |
364 | |
393 | |
365 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
394 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
366 | |
395 | |
367 | C<aio_readahead> populates the page cache with data from a file so that |
396 | C<aio_readahead> populates the page cache with data from a file so that |
368 | subsequent reads from that file will not block on disk I/O. The C<$offset> |
397 | subsequent reads from that file will not block on disk I/O. The C<$offset> |
… | |
… | |
374 | file. The current file offset of the file is left unchanged. |
403 | file. The current file offset of the file is left unchanged. |
375 | |
404 | |
376 | If that syscall doesn't exist (likely if your OS isn't Linux) it will be |
405 | If that syscall doesn't exist (likely if your OS isn't Linux) it will be |
377 | emulated by simply reading the data, which would have a similar effect. |
406 | emulated by simply reading the data, which would have a similar effect. |
378 | |
407 | |
|
|
408 | |
379 | =item aio_stat $fh_or_path, $callback->($status) |
409 | =item aio_stat $fh_or_path, $callback->($status) |
380 | |
410 | |
381 | =item aio_lstat $fh, $callback->($status) |
411 | =item aio_lstat $fh, $callback->($status) |
382 | |
412 | |
383 | Works like perl's C<stat> or C<lstat> in void context. The callback will |
413 | Works like perl's C<stat> or C<lstat> in void context. The callback will |
… | |
… | |
396 | aio_stat "/etc/passwd", sub { |
426 | aio_stat "/etc/passwd", sub { |
397 | $_[0] and die "stat failed: $!"; |
427 | $_[0] and die "stat failed: $!"; |
398 | print "size is ", -s _, "\n"; |
428 | print "size is ", -s _, "\n"; |
399 | }; |
429 | }; |
400 | |
430 | |
|
|
431 | |
|
|
432 | =item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
|
|
433 | |
|
|
434 | Works like perl's C<utime> function (including the special case of $atime |
|
|
435 | and $mtime being undef). Fractional times are supported if the underlying |
|
|
436 | syscalls support them. |
|
|
437 | |
|
|
438 | When called with a pathname, uses utimes(2) if available, otherwise |
|
|
439 | utime(2). If called on a file descriptor, uses futimes(2) if available, |
|
|
440 | otherwise returns ENOSYS, so this is not portable. |
|
|
441 | |
|
|
442 | Examples: |
|
|
443 | |
|
|
444 | # set atime and mtime to current time (basically touch(1)): |
|
|
445 | aio_utime "path", undef, undef; |
|
|
446 | # set atime to current time and mtime to beginning of the epoch: |
|
|
447 | aio_utime "path", time, undef; # undef==0 |
|
|
448 | |
|
|
449 | |
|
|
450 | =item aio_chown $fh_or_path, $uid, $gid, $callback->($status) |
|
|
451 | |
|
|
452 | Works like perl's C<chown> function, except that C<undef> for either $uid |
|
|
453 | or $gid is being interpreted as "do not change" (but -1 can also be used). |
|
|
454 | |
|
|
455 | Examples: |
|
|
456 | |
|
|
457 | # same as "chown root path" in the shell: |
|
|
458 | aio_chown "path", 0, -1; |
|
|
459 | # same as above: |
|
|
460 | aio_chown "path", 0, undef; |
|
|
461 | |
|
|
462 | |
|
|
463 | =item aio_truncate $fh_or_path, $offset, $callback->($status) |
|
|
464 | |
|
|
465 | Works like truncate(2) or ftruncate(2). |
|
|
466 | |
|
|
467 | |
|
|
468 | =item aio_chmod $fh_or_path, $mode, $callback->($status) |
|
|
469 | |
|
|
470 | Works like perl's C<chmod> function. |
|
|
471 | |
|
|
472 | |
401 | =item aio_unlink $pathname, $callback->($status) |
473 | =item aio_unlink $pathname, $callback->($status) |
402 | |
474 | |
403 | Asynchronously unlink (delete) a file and call the callback with the |
475 | Asynchronously unlink (delete) a file and call the callback with the |
404 | result code. |
476 | result code. |
405 | |
477 | |
|
|
478 | |
406 | =item aio_mknod $path, $mode, $dev, $callback->($status) |
479 | =item aio_mknod $path, $mode, $dev, $callback->($status) |
407 | |
480 | |
408 | [EXPERIMENTAL] |
481 | [EXPERIMENTAL] |
409 | |
482 | |
410 | Asynchronously create a device node (or fifo). See mknod(2). |
483 | Asynchronously create a device node (or fifo). See mknod(2). |
411 | |
484 | |
412 | The only (POSIX-) portable way of calling this function is: |
485 | The only (POSIX-) portable way of calling this function is: |
413 | |
486 | |
414 | aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... |
487 | aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... |
|
|
488 | |
415 | |
489 | |
416 | =item aio_link $srcpath, $dstpath, $callback->($status) |
490 | =item aio_link $srcpath, $dstpath, $callback->($status) |
417 | |
491 | |
418 | Asynchronously create a new link to the existing object at C<$srcpath> at |
492 | Asynchronously create a new link to the existing object at C<$srcpath> at |
419 | the path C<$dstpath> and call the callback with the result code. |
493 | the path C<$dstpath> and call the callback with the result code. |
420 | |
494 | |
|
|
495 | |
421 | =item aio_symlink $srcpath, $dstpath, $callback->($status) |
496 | =item aio_symlink $srcpath, $dstpath, $callback->($status) |
422 | |
497 | |
423 | Asynchronously create a new symbolic link to the existing object at C<$srcpath> at |
498 | Asynchronously create a new symbolic link to the existing object at C<$srcpath> at |
424 | the path C<$dstpath> and call the callback with the result code. |
499 | the path C<$dstpath> and call the callback with the result code. |
|
|
500 | |
425 | |
501 | |
426 | =item aio_readlink $path, $callback->($link) |
502 | =item aio_readlink $path, $callback->($link) |
427 | |
503 | |
428 | Asynchronously read the symlink specified by C<$path> and pass it to |
504 | Asynchronously read the symlink specified by C<$path> and pass it to |
429 | the callback. If an error occurs, nothing or undef gets passed to the |
505 | the callback. If an error occurs, nothing or undef gets passed to the |
430 | callback. |
506 | callback. |
431 | |
507 | |
|
|
508 | |
432 | =item aio_rename $srcpath, $dstpath, $callback->($status) |
509 | =item aio_rename $srcpath, $dstpath, $callback->($status) |
433 | |
510 | |
434 | Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as |
511 | Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as |
435 | rename(2) and call the callback with the result code. |
512 | rename(2) and call the callback with the result code. |
|
|
513 | |
436 | |
514 | |
437 | =item aio_mkdir $pathname, $mode, $callback->($status) |
515 | =item aio_mkdir $pathname, $mode, $callback->($status) |
438 | |
516 | |
439 | Asynchronously mkdir (create) a directory and call the callback with |
517 | Asynchronously mkdir (create) a directory and call the callback with |
440 | the result code. C<$mode> will be modified by the umask at the time the |
518 | the result code. C<$mode> will be modified by the umask at the time the |
441 | request is executed, so do not change your umask. |
519 | request is executed, so do not change your umask. |
442 | |
520 | |
|
|
521 | |
443 | =item aio_rmdir $pathname, $callback->($status) |
522 | =item aio_rmdir $pathname, $callback->($status) |
444 | |
523 | |
445 | Asynchronously rmdir (delete) a directory and call the callback with the |
524 | Asynchronously rmdir (delete) a directory and call the callback with the |
446 | result code. |
525 | result code. |
|
|
526 | |
447 | |
527 | |
448 | =item aio_readdir $pathname, $callback->($entries) |
528 | =item aio_readdir $pathname, $callback->($entries) |
449 | |
529 | |
450 | Unlike the POSIX call of the same name, C<aio_readdir> reads an entire |
530 | Unlike the POSIX call of the same name, C<aio_readdir> reads an entire |
451 | directory (i.e. opendir + readdir + closedir). The entries will not be |
531 | directory (i.e. opendir + readdir + closedir). The entries will not be |
452 | sorted, and will B<NOT> include the C<.> and C<..> entries. |
532 | sorted, and will B<NOT> include the C<.> and C<..> entries. |
453 | |
533 | |
454 | The callback a single argument which is either C<undef> or an array-ref |
534 | The callback a single argument which is either C<undef> or an array-ref |
455 | with the filenames. |
535 | with the filenames. |
456 | |
536 | |
|
|
537 | |
457 | =item aio_load $path, $data, $callback->($status) |
538 | =item aio_load $path, $data, $callback->($status) |
458 | |
539 | |
459 | This is a composite request that tries to fully load the given file into |
540 | This is a composite request that tries to fully load the given file into |
460 | memory. Status is the same as with aio_read. |
541 | memory. Status is the same as with aio_read. |
461 | |
542 | |
462 | =cut |
543 | =cut |
463 | |
544 | |
464 | sub aio_load($$;$) { |
545 | sub aio_load($$;$) { |
465 | aio_block { |
|
|
466 | my ($path, undef, $cb) = @_; |
546 | my ($path, undef, $cb) = @_; |
467 | my $data = \$_[1]; |
547 | my $data = \$_[1]; |
468 | |
548 | |
469 | my $pri = aioreq_pri; |
549 | my $pri = aioreq_pri; |
470 | my $grp = aio_group $cb; |
550 | my $grp = aio_group $cb; |
|
|
551 | |
|
|
552 | aioreq_pri $pri; |
|
|
553 | add $grp aio_open $path, O_RDONLY, 0, sub { |
|
|
554 | my $fh = shift |
|
|
555 | or return $grp->result (-1); |
471 | |
556 | |
472 | aioreq_pri $pri; |
557 | aioreq_pri $pri; |
473 | add $grp aio_open $path, O_RDONLY, 0, sub { |
|
|
474 | my $fh = shift |
|
|
475 | or return $grp->result (-1); |
|
|
476 | |
|
|
477 | aioreq_pri $pri; |
|
|
478 | add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub { |
558 | add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub { |
479 | $grp->result ($_[0]); |
559 | $grp->result ($_[0]); |
480 | }; |
|
|
481 | }; |
560 | }; |
482 | |
|
|
483 | $grp |
|
|
484 | } |
561 | }; |
|
|
562 | |
|
|
563 | $grp |
485 | } |
564 | } |
486 | |
565 | |
487 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
566 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
488 | |
567 | |
489 | Try to copy the I<file> (directories not supported as either source or |
568 | Try to copy the I<file> (directories not supported as either source or |
490 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
569 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
491 | the C<0> (error) or C<-1> ok. |
570 | the C<0> (error) or C<-1> ok. |
492 | |
571 | |
493 | This is a composite request that it creates the destination file with |
572 | This is a composite request that creates the destination file with |
494 | mode 0200 and copies the contents of the source file into it using |
573 | mode 0200 and copies the contents of the source file into it using |
495 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
574 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
496 | uid/gid, in that order. |
575 | uid/gid, in that order. |
497 | |
576 | |
498 | If an error occurs, the partial destination file will be unlinked, if |
577 | If an error occurs, the partial destination file will be unlinked, if |
… | |
… | |
500 | errors are being ignored. |
579 | errors are being ignored. |
501 | |
580 | |
502 | =cut |
581 | =cut |
503 | |
582 | |
504 | sub aio_copy($$;$) { |
583 | sub aio_copy($$;$) { |
505 | aio_block { |
|
|
506 | my ($src, $dst, $cb) = @_; |
584 | my ($src, $dst, $cb) = @_; |
507 | |
585 | |
508 | my $pri = aioreq_pri; |
586 | my $pri = aioreq_pri; |
509 | my $grp = aio_group $cb; |
587 | my $grp = aio_group $cb; |
510 | |
588 | |
511 | aioreq_pri $pri; |
589 | aioreq_pri $pri; |
512 | add $grp aio_open $src, O_RDONLY, 0, sub { |
590 | add $grp aio_open $src, O_RDONLY, 0, sub { |
513 | if (my $src_fh = $_[0]) { |
591 | if (my $src_fh = $_[0]) { |
514 | my @stat = stat $src_fh; |
592 | my @stat = stat $src_fh; |
515 | |
593 | |
516 | aioreq_pri $pri; |
594 | aioreq_pri $pri; |
517 | add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { |
595 | add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { |
518 | if (my $dst_fh = $_[0]) { |
596 | if (my $dst_fh = $_[0]) { |
519 | aioreq_pri $pri; |
597 | aioreq_pri $pri; |
520 | add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { |
598 | add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { |
521 | if ($_[0] == $stat[7]) { |
599 | if ($_[0] == $stat[7]) { |
522 | $grp->result (0); |
600 | $grp->result (0); |
523 | close $src_fh; |
601 | close $src_fh; |
524 | |
602 | |
525 | # those should not normally block. should. should. |
603 | # those should not normally block. should. should. |
526 | utime $stat[8], $stat[9], $dst; |
604 | utime $stat[8], $stat[9], $dst; |
527 | chmod $stat[2] & 07777, $dst_fh; |
605 | chmod $stat[2] & 07777, $dst_fh; |
528 | chown $stat[4], $stat[5], $dst_fh; |
606 | chown $stat[4], $stat[5], $dst_fh; |
|
|
607 | |
|
|
608 | aioreq_pri $pri; |
529 | close $dst_fh; |
609 | add $grp aio_close $dst_fh; |
530 | } else { |
610 | } else { |
531 | $grp->result (-1); |
611 | $grp->result (-1); |
532 | close $src_fh; |
612 | close $src_fh; |
533 | close $dst_fh; |
613 | close $dst_fh; |
534 | |
614 | |
535 | aioreq $pri; |
615 | aioreq $pri; |
536 | add $grp aio_unlink $dst; |
616 | add $grp aio_unlink $dst; |
537 | } |
|
|
538 | }; |
617 | } |
539 | } else { |
|
|
540 | $grp->result (-1); |
|
|
541 | } |
618 | }; |
|
|
619 | } else { |
|
|
620 | $grp->result (-1); |
542 | }, |
621 | } |
543 | |
|
|
544 | } else { |
|
|
545 | $grp->result (-1); |
|
|
546 | } |
622 | }, |
|
|
623 | |
|
|
624 | } else { |
|
|
625 | $grp->result (-1); |
547 | }; |
626 | } |
548 | |
|
|
549 | $grp |
|
|
550 | } |
627 | }; |
|
|
628 | |
|
|
629 | $grp |
551 | } |
630 | } |
552 | |
631 | |
553 | =item aio_move $srcpath, $dstpath, $callback->($status) |
632 | =item aio_move $srcpath, $dstpath, $callback->($status) |
554 | |
633 | |
555 | Try to move the I<file> (directories not supported as either source or |
634 | Try to move the I<file> (directories not supported as either source or |
556 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
635 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
557 | the C<0> (error) or C<-1> ok. |
636 | the C<0> (error) or C<-1> ok. |
558 | |
637 | |
559 | This is a composite request that tries to rename(2) the file first. If |
638 | This is a composite request that tries to rename(2) the file first; if |
560 | rename files with C<EXDEV>, it copies the file with C<aio_copy> and, if |
639 | rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if |
561 | that is successful, unlinking the C<$srcpath>. |
640 | that is successful, unlinks the C<$srcpath>. |
562 | |
641 | |
563 | =cut |
642 | =cut |
564 | |
643 | |
565 | sub aio_move($$;$) { |
644 | sub aio_move($$;$) { |
566 | aio_block { |
|
|
567 | my ($src, $dst, $cb) = @_; |
645 | my ($src, $dst, $cb) = @_; |
568 | |
646 | |
569 | my $pri = aioreq_pri; |
647 | my $pri = aioreq_pri; |
570 | my $grp = aio_group $cb; |
648 | my $grp = aio_group $cb; |
571 | |
649 | |
572 | aioreq_pri $pri; |
650 | aioreq_pri $pri; |
573 | add $grp aio_rename $src, $dst, sub { |
651 | add $grp aio_rename $src, $dst, sub { |
574 | if ($_[0] && $! == EXDEV) { |
652 | if ($_[0] && $! == EXDEV) { |
575 | aioreq_pri $pri; |
653 | aioreq_pri $pri; |
576 | add $grp aio_copy $src, $dst, sub { |
654 | add $grp aio_copy $src, $dst, sub { |
577 | $grp->result ($_[0]); |
|
|
578 | |
|
|
579 | if (!$_[0]) { |
|
|
580 | aioreq_pri $pri; |
|
|
581 | add $grp aio_unlink $src; |
|
|
582 | } |
|
|
583 | }; |
|
|
584 | } else { |
|
|
585 | $grp->result ($_[0]); |
655 | $grp->result ($_[0]); |
|
|
656 | |
|
|
657 | if (!$_[0]) { |
|
|
658 | aioreq_pri $pri; |
|
|
659 | add $grp aio_unlink $src; |
|
|
660 | } |
586 | } |
661 | }; |
|
|
662 | } else { |
|
|
663 | $grp->result ($_[0]); |
587 | }; |
664 | } |
588 | |
|
|
589 | $grp |
|
|
590 | } |
665 | }; |
|
|
666 | |
|
|
667 | $grp |
591 | } |
668 | } |
592 | |
669 | |
593 | =item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
670 | =item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
594 | |
671 | |
595 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
672 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
… | |
… | |
643 | directory counting heuristic. |
720 | directory counting heuristic. |
644 | |
721 | |
645 | =cut |
722 | =cut |
646 | |
723 | |
647 | sub aio_scandir($$;$) { |
724 | sub aio_scandir($$;$) { |
648 | aio_block { |
|
|
649 | my ($path, $maxreq, $cb) = @_; |
725 | my ($path, $maxreq, $cb) = @_; |
650 | |
726 | |
651 | my $pri = aioreq_pri; |
727 | my $pri = aioreq_pri; |
652 | |
728 | |
653 | my $grp = aio_group $cb; |
729 | my $grp = aio_group $cb; |
654 | |
730 | |
655 | $maxreq = 4 if $maxreq <= 0; |
731 | $maxreq = 4 if $maxreq <= 0; |
656 | |
732 | |
657 | # stat once |
733 | # stat once |
|
|
734 | aioreq_pri $pri; |
|
|
735 | add $grp aio_stat $path, sub { |
|
|
736 | return $grp->result () if $_[0]; |
|
|
737 | my $now = time; |
|
|
738 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
|
|
739 | |
|
|
740 | # read the directory entries |
658 | aioreq_pri $pri; |
741 | aioreq_pri $pri; |
659 | add $grp aio_stat $path, sub { |
742 | add $grp aio_readdir $path, sub { |
|
|
743 | my $entries = shift |
660 | return $grp->result () if $_[0]; |
744 | or return $grp->result (); |
661 | my $now = time; |
|
|
662 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
|
|
663 | |
745 | |
664 | # read the directory entries |
746 | # stat the dir another time |
665 | aioreq_pri $pri; |
747 | aioreq_pri $pri; |
666 | add $grp aio_readdir $path, sub { |
|
|
667 | my $entries = shift |
|
|
668 | or return $grp->result (); |
|
|
669 | |
|
|
670 | # stat the dir another time |
|
|
671 | aioreq_pri $pri; |
|
|
672 | add $grp aio_stat $path, sub { |
748 | add $grp aio_stat $path, sub { |
673 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
749 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
674 | |
750 | |
675 | my $ndirs; |
751 | my $ndirs; |
676 | |
752 | |
677 | # take the slow route if anything looks fishy |
753 | # take the slow route if anything looks fishy |
678 | if ($hash1 ne $hash2 or (stat _)[9] == $now) { |
754 | if ($hash1 ne $hash2 or (stat _)[9] == $now) { |
679 | $ndirs = -1; |
755 | $ndirs = -1; |
680 | } else { |
756 | } else { |
681 | # if nlink == 2, we are finished |
757 | # if nlink == 2, we are finished |
682 | # on non-posix-fs's, we rely on nlink < 2 |
758 | # on non-posix-fs's, we rely on nlink < 2 |
683 | $ndirs = (stat _)[3] - 2 |
759 | $ndirs = (stat _)[3] - 2 |
684 | or return $grp->result ([], $entries); |
760 | or return $grp->result ([], $entries); |
685 | } |
761 | } |
686 | |
762 | |
687 | # sort into likely dirs and likely nondirs |
763 | # sort into likely dirs and likely nondirs |
688 | # dirs == files without ".", short entries first |
764 | # dirs == files without ".", short entries first |
689 | $entries = [map $_->[0], |
765 | $entries = [map $_->[0], |
690 | sort { $b->[1] cmp $a->[1] } |
766 | sort { $b->[1] cmp $a->[1] } |
691 | map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], |
767 | map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], |
692 | @$entries]; |
768 | @$entries]; |
693 | |
769 | |
694 | my (@dirs, @nondirs); |
770 | my (@dirs, @nondirs); |
695 | |
771 | |
696 | my $statgrp = add $grp aio_group sub { |
772 | my $statgrp = add $grp aio_group sub { |
697 | $grp->result (\@dirs, \@nondirs); |
773 | $grp->result (\@dirs, \@nondirs); |
698 | }; |
774 | }; |
699 | |
775 | |
700 | limit $statgrp $maxreq; |
776 | limit $statgrp $maxreq; |
701 | feed $statgrp sub { |
777 | feed $statgrp sub { |
702 | return unless @$entries; |
778 | return unless @$entries; |
703 | my $entry = pop @$entries; |
779 | my $entry = pop @$entries; |
704 | |
780 | |
705 | aioreq_pri $pri; |
781 | aioreq_pri $pri; |
706 | add $statgrp aio_stat "$path/$entry/.", sub { |
782 | add $statgrp aio_stat "$path/$entry/.", sub { |
707 | if ($_[0] < 0) { |
783 | if ($_[0] < 0) { |
708 | push @nondirs, $entry; |
784 | push @nondirs, $entry; |
709 | } else { |
785 | } else { |
710 | # need to check for real directory |
786 | # need to check for real directory |
711 | aioreq_pri $pri; |
787 | aioreq_pri $pri; |
712 | add $statgrp aio_lstat "$path/$entry", sub { |
788 | add $statgrp aio_lstat "$path/$entry", sub { |
713 | if (-d _) { |
789 | if (-d _) { |
714 | push @dirs, $entry; |
790 | push @dirs, $entry; |
715 | |
791 | |
716 | unless (--$ndirs) { |
792 | unless (--$ndirs) { |
717 | push @nondirs, @$entries; |
793 | push @nondirs, @$entries; |
718 | feed $statgrp; |
794 | feed $statgrp; |
719 | } |
|
|
720 | } else { |
|
|
721 | push @nondirs, $entry; |
|
|
722 | } |
795 | } |
|
|
796 | } else { |
|
|
797 | push @nondirs, $entry; |
723 | } |
798 | } |
724 | } |
799 | } |
725 | }; |
800 | } |
726 | }; |
801 | }; |
727 | }; |
802 | }; |
728 | }; |
803 | }; |
729 | }; |
804 | }; |
730 | |
|
|
731 | $grp |
|
|
732 | } |
805 | }; |
|
|
806 | |
|
|
807 | $grp |
733 | } |
808 | } |
734 | |
809 | |
735 | =item aio_rmtree $path, $callback->($status) |
810 | =item aio_rmtree $path, $callback->($status) |
736 | |
811 | |
737 | Delete a directory tree starting (and including) C<$path>, return the |
812 | Delete a directory tree starting (and including) C<$path>, return the |
… | |
… | |
741 | |
816 | |
742 | =cut |
817 | =cut |
743 | |
818 | |
744 | sub aio_rmtree; |
819 | sub aio_rmtree; |
745 | sub aio_rmtree($;$) { |
820 | sub aio_rmtree($;$) { |
746 | aio_block { |
|
|
747 | my ($path, $cb) = @_; |
821 | my ($path, $cb) = @_; |
748 | |
822 | |
749 | my $pri = aioreq_pri; |
823 | my $pri = aioreq_pri; |
750 | my $grp = aio_group $cb; |
824 | my $grp = aio_group $cb; |
751 | |
825 | |
752 | aioreq_pri $pri; |
826 | aioreq_pri $pri; |
753 | add $grp aio_scandir $path, 0, sub { |
827 | add $grp aio_scandir $path, 0, sub { |
754 | my ($dirs, $nondirs) = @_; |
828 | my ($dirs, $nondirs) = @_; |
755 | |
829 | |
756 | my $dirgrp = aio_group sub { |
830 | my $dirgrp = aio_group sub { |
757 | add $grp aio_rmdir $path, sub { |
831 | add $grp aio_rmdir $path, sub { |
758 | $grp->result ($_[0]); |
832 | $grp->result ($_[0]); |
759 | }; |
|
|
760 | }; |
833 | }; |
761 | |
|
|
762 | (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs; |
|
|
763 | (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs; |
|
|
764 | |
|
|
765 | add $grp $dirgrp; |
|
|
766 | }; |
834 | }; |
767 | |
835 | |
768 | $grp |
836 | (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs; |
|
|
837 | (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs; |
|
|
838 | |
|
|
839 | add $grp $dirgrp; |
769 | } |
840 | }; |
|
|
841 | |
|
|
842 | $grp |
770 | } |
843 | } |
|
|
844 | |
|
|
845 | =item aio_sync $callback->($status) |
|
|
846 | |
|
|
847 | Asynchronously call sync and call the callback when finished. |
771 | |
848 | |
772 | =item aio_fsync $fh, $callback->($status) |
849 | =item aio_fsync $fh, $callback->($status) |
773 | |
850 | |
774 | Asynchronously call fsync on the given filehandle and call the callback |
851 | Asynchronously call fsync on the given filehandle and call the callback |
775 | with the fsync result code. |
852 | with the fsync result code. |
… | |
… | |
779 | Asynchronously call fdatasync on the given filehandle and call the |
856 | Asynchronously call fdatasync on the given filehandle and call the |
780 | callback with the fdatasync result code. |
857 | callback with the fdatasync result code. |
781 | |
858 | |
782 | If this call isn't available because your OS lacks it or it couldn't be |
859 | If this call isn't available because your OS lacks it or it couldn't be |
783 | detected, it will be emulated by calling C<fsync> instead. |
860 | detected, it will be emulated by calling C<fsync> instead. |
|
|
861 | |
|
|
862 | =item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
|
|
863 | |
|
|
864 | Sync the data portion of the file specified by C<$offset> and C<$length> |
|
|
865 | to disk (but NOT the metadata), by calling the Linux-specific |
|
|
866 | sync_file_range call. If sync_file_range is not available or it returns |
|
|
867 | ENOSYS, then fdatasync or fsync is being substituted. |
|
|
868 | |
|
|
869 | C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>, |
|
|
870 | C<IO::AIO::SYNC_FILE_RANGE_WRITE> and |
|
|
871 | C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range |
|
|
872 | manpage for details. |
|
|
873 | |
|
|
874 | =item aio_pathsync $path, $callback->($status) |
|
|
875 | |
|
|
876 | This request tries to open, fsync and close the given path. This is a |
|
|
877 | composite request intended to sync directories after directory operations |
|
|
878 | (E.g. rename). This might not work on all operating systems or have any |
|
|
879 | specific effect, but usually it makes sure that directory changes get |
|
|
880 | written to disc. It works for anything that can be opened for read-only, |
|
|
881 | not just directories. |
|
|
882 | |
|
|
883 | Passes C<0> when everything went ok, and C<-1> on error. |
|
|
884 | |
|
|
885 | =cut |
|
|
886 | |
|
|
887 | sub aio_pathsync($;$) { |
|
|
888 | my ($path, $cb) = @_; |
|
|
889 | |
|
|
890 | my $pri = aioreq_pri; |
|
|
891 | my $grp = aio_group $cb; |
|
|
892 | |
|
|
893 | aioreq_pri $pri; |
|
|
894 | add $grp aio_open $path, O_RDONLY, 0, sub { |
|
|
895 | my ($fh) = @_; |
|
|
896 | if ($fh) { |
|
|
897 | aioreq_pri $pri; |
|
|
898 | add $grp aio_fsync $fh, sub { |
|
|
899 | $grp->result ($_[0]); |
|
|
900 | |
|
|
901 | aioreq_pri $pri; |
|
|
902 | add $grp aio_close $fh; |
|
|
903 | }; |
|
|
904 | } else { |
|
|
905 | $grp->result (-1); |
|
|
906 | } |
|
|
907 | }; |
|
|
908 | |
|
|
909 | $grp |
|
|
910 | } |
784 | |
911 | |
785 | =item aio_group $callback->(...) |
912 | =item aio_group $callback->(...) |
786 | |
913 | |
787 | This is a very special aio request: Instead of doing something, it is a |
914 | This is a very special aio request: Instead of doing something, it is a |
788 | container for other aio requests, which is useful if you want to bundle |
915 | container for other aio requests, which is useful if you want to bundle |
… | |
… | |
900 | Their lifetime, simplified, looks like this: when they are empty, they |
1027 | Their lifetime, simplified, looks like this: when they are empty, they |
901 | will finish very quickly. If they contain only requests that are in the |
1028 | will finish very quickly. If they contain only requests that are in the |
902 | C<done> state, they will also finish. Otherwise they will continue to |
1029 | C<done> state, they will also finish. Otherwise they will continue to |
903 | exist. |
1030 | exist. |
904 | |
1031 | |
905 | That means after creating a group you have some time to add requests. And |
1032 | That means after creating a group you have some time to add requests |
906 | in the callbacks of those requests, you can add further requests to the |
1033 | (precisely before the callback has been invoked, which is only done within |
907 | group. And only when all those requests have finished will the the group |
1034 | the C<poll_cb>). And in the callbacks of those requests, you can add |
908 | itself finish. |
1035 | further requests to the group. And only when all those requests have |
|
|
1036 | finished will the the group itself finish. |
909 | |
1037 | |
910 | =over 4 |
1038 | =over 4 |
911 | |
1039 | |
912 | =item add $grp ... |
1040 | =item add $grp ... |
913 | |
1041 | |
… | |
… | |
925 | itself. Useful when you queued a lot of events but got a result early. |
1053 | itself. Useful when you queued a lot of events but got a result early. |
926 | |
1054 | |
927 | =item $grp->result (...) |
1055 | =item $grp->result (...) |
928 | |
1056 | |
929 | Set the result value(s) that will be passed to the group callback when all |
1057 | Set the result value(s) that will be passed to the group callback when all |
930 | subrequests have finished and set thre groups errno to the current value |
1058 | subrequests have finished and set the groups errno to the current value |
931 | of errno (just like calling C<errno> without an error number). By default, |
1059 | of errno (just like calling C<errno> without an error number). By default, |
932 | no argument will be passed and errno is zero. |
1060 | no argument will be passed and errno is zero. |
933 | |
1061 | |
934 | =item $grp->errno ([$errno]) |
1062 | =item $grp->errno ([$errno]) |
935 | |
1063 | |
… | |
… | |
946 | =item feed $grp $callback->($grp) |
1074 | =item feed $grp $callback->($grp) |
947 | |
1075 | |
948 | Sets a feeder/generator on this group: every group can have an attached |
1076 | Sets a feeder/generator on this group: every group can have an attached |
949 | generator that generates requests if idle. The idea behind this is that, |
1077 | generator that generates requests if idle. The idea behind this is that, |
950 | although you could just queue as many requests as you want in a group, |
1078 | although you could just queue as many requests as you want in a group, |
951 | this might starve other requests for a potentially long time. For |
1079 | this might starve other requests for a potentially long time. For example, |
952 | example, C<aio_scandir> might generate hundreds of thousands C<aio_stat> |
1080 | C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests, |
953 | requests, delaying any later requests for a long time. |
1081 | delaying any later requests for a long time. |
954 | |
1082 | |
955 | To avoid this, and allow incremental generation of requests, you can |
1083 | To avoid this, and allow incremental generation of requests, you can |
956 | instead a group and set a feeder on it that generates those requests. The |
1084 | instead a group and set a feeder on it that generates those requests. The |
957 | feed callback will be called whenever there are few enough (see C<limit>, |
1085 | feed callback will be called whenever there are few enough (see C<limit>, |
958 | below) requests active in the group itself and is expected to queue more |
1086 | below) requests active in the group itself and is expected to queue more |
… | |
… | |
962 | not impose any limits). |
1090 | not impose any limits). |
963 | |
1091 | |
964 | If the feed does not queue more requests when called, it will be |
1092 | If the feed does not queue more requests when called, it will be |
965 | automatically removed from the group. |
1093 | automatically removed from the group. |
966 | |
1094 | |
967 | If the feed limit is C<0>, it will be set to C<2> automatically. |
1095 | If the feed limit is C<0> when this method is called, it will be set to |
|
|
1096 | C<2> automatically. |
968 | |
1097 | |
969 | Example: |
1098 | Example: |
970 | |
1099 | |
971 | # stat all files in @files, but only ever use four aio requests concurrently: |
1100 | # stat all files in @files, but only ever use four aio requests concurrently: |
972 | |
1101 | |
… | |
… | |
984 | Sets the feeder limit for the group: The feeder will be called whenever |
1113 | Sets the feeder limit for the group: The feeder will be called whenever |
985 | the group contains less than this many requests. |
1114 | the group contains less than this many requests. |
986 | |
1115 | |
987 | Setting the limit to C<0> will pause the feeding process. |
1116 | Setting the limit to C<0> will pause the feeding process. |
988 | |
1117 | |
|
|
1118 | The default value for the limit is C<0>, but note that setting a feeder |
|
|
1119 | automatically bumps it up to C<2>. |
|
|
1120 | |
989 | =back |
1121 | =back |
990 | |
1122 | |
991 | =head2 SUPPORT FUNCTIONS |
1123 | =head2 SUPPORT FUNCTIONS |
992 | |
1124 | |
993 | =head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION |
1125 | =head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION |
… | |
… | |
1004 | See C<poll_cb> for an example. |
1136 | See C<poll_cb> for an example. |
1005 | |
1137 | |
1006 | =item IO::AIO::poll_cb |
1138 | =item IO::AIO::poll_cb |
1007 | |
1139 | |
1008 | Process some outstanding events on the result pipe. You have to call this |
1140 | Process some outstanding events on the result pipe. You have to call this |
1009 | regularly. Returns the number of events processed. Returns immediately |
1141 | regularly. Returns C<0> if all events could be processed, or C<-1> if it |
|
|
1142 | returned earlier for whatever reason. Returns immediately when no events |
1010 | when no events are outstanding. The amount of events processed depends on |
1143 | are outstanding. The amount of events processed depends on the settings of |
1011 | the settings of C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>. |
1144 | C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>. |
1012 | |
1145 | |
1013 | If not all requests were processed for whatever reason, the filehandle |
1146 | If not all requests were processed for whatever reason, the filehandle |
1014 | will still be ready when C<poll_cb> returns. |
1147 | will still be ready when C<poll_cb> returns, so normally you don't have to |
|
|
1148 | do anything special to have it called later. |
1015 | |
1149 | |
1016 | Example: Install an Event watcher that automatically calls |
1150 | Example: Install an Event watcher that automatically calls |
1017 | IO::AIO::poll_cb with high priority: |
1151 | IO::AIO::poll_cb with high priority: |
1018 | |
1152 | |
1019 | Event->io (fd => IO::AIO::poll_fileno, |
1153 | Event->io (fd => IO::AIO::poll_fileno, |
… | |
… | |
1133 | |
1267 | |
1134 | The default is probably ok in most situations, especially if thread |
1268 | The default is probably ok in most situations, especially if thread |
1135 | creation is fast. If thread creation is very slow on your system you might |
1269 | creation is fast. If thread creation is very slow on your system you might |
1136 | want to use larger values. |
1270 | want to use larger values. |
1137 | |
1271 | |
1138 | =item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs |
1272 | =item IO::AIO::max_outstanding $maxreqs |
1139 | |
1273 | |
1140 | This is a very bad function to use in interactive programs because it |
1274 | This is a very bad function to use in interactive programs because it |
1141 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1275 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1142 | use an C<aio_group> together with a feed callback. |
1276 | use an C<aio_group> together with a feed callback. |
1143 | |
1277 | |
1144 | Sets the maximum number of outstanding requests to C<$nreqs>. If you |
1278 | Sets the maximum number of outstanding requests to C<$nreqs>. If you |
1145 | to queue up more than this number of requests, the next call to the |
1279 | do queue up more than this number of requests, the next call to the |
1146 | C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>) |
1280 | C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>) |
1147 | function will block until the limit is no longer exceeded. |
1281 | function will block until the limit is no longer exceeded. |
1148 | |
1282 | |
1149 | The default value is very large, so there is no practical limit on the |
1283 | The default value is very large, so there is no practical limit on the |
1150 | number of outstanding requests. |
1284 | number of outstanding requests. |
1151 | |
1285 | |
1152 | You can still queue as many requests as you want. Therefore, |
1286 | You can still queue as many requests as you want. Therefore, |
1153 | C<max_oustsanding> is mainly useful in simple scripts (with low values) or |
1287 | C<max_outstanding> is mainly useful in simple scripts (with low values) or |
1154 | as a stop gap to shield against fatal memory overflow (with large values). |
1288 | as a stop gap to shield against fatal memory overflow (with large values). |
1155 | |
1289 | |
1156 | =back |
1290 | =back |
1157 | |
1291 | |
1158 | =head3 STATISTICAL INFORMATION |
1292 | =head3 STATISTICAL INFORMATION |
… | |
… | |
1180 | but not yet processed by poll_cb). |
1314 | but not yet processed by poll_cb). |
1181 | |
1315 | |
1182 | =back |
1316 | =back |
1183 | |
1317 | |
1184 | =cut |
1318 | =cut |
1185 | |
|
|
1186 | # support function to convert a fd into a perl filehandle |
|
|
1187 | sub _fd2fh { |
|
|
1188 | return undef if $_[0] < 0; |
|
|
1189 | |
|
|
1190 | # try to generate nice filehandles |
|
|
1191 | my $sym = "IO::AIO::fd#$_[0]"; |
|
|
1192 | local *$sym; |
|
|
1193 | |
|
|
1194 | open *$sym, "+<&=$_[0]" # usually works under any unix |
|
|
1195 | or open *$sym, "<&=$_[0]" # cygwin needs this |
|
|
1196 | or open *$sym, ">&=$_[0]" # or this |
|
|
1197 | or return undef; |
|
|
1198 | |
|
|
1199 | *$sym |
|
|
1200 | } |
|
|
1201 | |
1319 | |
1202 | min_parallel 8; |
1320 | min_parallel 8; |
1203 | |
1321 | |
1204 | END { flush } |
1322 | END { flush } |
1205 | |
1323 | |
… | |
… | |
1229 | bytes of memory. In addition, stat requests need a stat buffer (possibly |
1347 | bytes of memory. In addition, stat requests need a stat buffer (possibly |
1230 | a few hundred bytes), readdir requires a result buffer and so on. Perl |
1348 | a few hundred bytes), readdir requires a result buffer and so on. Perl |
1231 | scalars and other data passed into aio requests will also be locked and |
1349 | scalars and other data passed into aio requests will also be locked and |
1232 | will consume memory till the request has entered the done state. |
1350 | will consume memory till the request has entered the done state. |
1233 | |
1351 | |
1234 | This is now awfully much, so queuing lots of requests is not usually a |
1352 | This is not awfully much, so queuing lots of requests is not usually a |
1235 | problem. |
1353 | problem. |
1236 | |
1354 | |
1237 | Per-thread usage: |
1355 | Per-thread usage: |
1238 | |
1356 | |
1239 | In the execution phase, some aio requests require more memory for |
1357 | In the execution phase, some aio requests require more memory for |
… | |
… | |
1244 | |
1362 | |
1245 | Known bugs will be fixed in the next release. |
1363 | Known bugs will be fixed in the next release. |
1246 | |
1364 | |
1247 | =head1 SEE ALSO |
1365 | =head1 SEE ALSO |
1248 | |
1366 | |
1249 | L<Coro::AIO>. |
1367 | L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a |
|
|
1368 | more natural syntax. |
1250 | |
1369 | |
1251 | =head1 AUTHOR |
1370 | =head1 AUTHOR |
1252 | |
1371 | |
1253 | Marc Lehmann <schmorp@schmorp.de> |
1372 | Marc Lehmann <schmorp@schmorp.de> |
1254 | http://home.schmorp.de/ |
1373 | http://home.schmorp.de/ |