… | |
… | |
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 |
31 | # AnyEvent integration (EV, Event, Glib, Tk, urxvt, pureperl...) |
32 | open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!"; |
32 | open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!"; |
33 | my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb }); |
33 | my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb }); |
|
|
34 | |
|
|
35 | # EV integration |
|
|
36 | my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; |
34 | |
37 | |
35 | # Event integration |
38 | # Event integration |
36 | Event->io (fd => IO::AIO::poll_fileno, |
39 | Event->io (fd => IO::AIO::poll_fileno, |
37 | poll => 'r', |
40 | poll => 'r', |
38 | cb => \&IO::AIO::poll_cb); |
41 | cb => \&IO::AIO::poll_cb); |
… | |
… | |
62 | etc.), but can also be used to easily do operations in parallel that are |
65 | 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 |
66 | 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 |
67 | on a RAID volume or over NFS when you do a number of stat operations |
65 | concurrently. |
68 | concurrently. |
66 | |
69 | |
67 | While most of this works on all types of file descriptors (for example |
70 | While most of this works on all types of file descriptors (for |
68 | sockets), using these functions on file descriptors that support |
71 | example sockets), using these functions on file descriptors that |
69 | nonblocking operation (again, sockets, pipes etc.) is very inefficient or |
72 | support nonblocking operation (again, sockets, pipes etc.) is very |
70 | might not work (aio_read fails on sockets/pipes/fifos). Use an event loop |
73 | 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 |
74 | module): IO::AIO will naturally fit into such an event loop itself. |
72 | into such an event loop itself. |
|
|
73 | |
75 | |
74 | In this version, a number of threads are started that execute your |
76 | In this version, a number of threads are started that execute your |
75 | requests and signal their completion. You don't need thread support |
77 | 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 |
78 | 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 |
79 | 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 |
81 | 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 |
82 | files currently, for example), and they would only support aio_read and |
81 | aio_write, so the remaining functionality would have to be implemented |
83 | aio_write, so the remaining functionality would have to be implemented |
82 | using threads anyway. |
84 | using threads anyway. |
83 | |
85 | |
84 | Although the module will work with in the presence of other (Perl-) |
86 | 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 |
87 | 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 |
88 | 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. |
89 | call C<poll_cb> (or other C<aio_> functions) recursively. |
88 | |
90 | |
89 | =head2 EXAMPLE |
91 | =head2 EXAMPLE |
90 | |
92 | |
91 | This is a simple example that uses the Event module and loads |
93 | This is a simple example that uses the Event module and loads |
92 | F</etc/passwd> asynchronously: |
94 | F</etc/passwd> asynchronously: |
… | |
… | |
184 | |
186 | |
185 | =cut |
187 | =cut |
186 | |
188 | |
187 | package IO::AIO; |
189 | package IO::AIO; |
188 | |
190 | |
|
|
191 | use Carp (); |
|
|
192 | |
189 | no warnings; |
193 | no warnings; |
190 | use strict 'vars'; |
194 | use strict 'vars'; |
191 | |
195 | |
192 | use base 'Exporter'; |
196 | use base 'Exporter'; |
193 | |
197 | |
194 | BEGIN { |
198 | BEGIN { |
195 | our $VERSION = '2.33'; |
199 | our $VERSION = '2.61'; |
196 | |
200 | |
197 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat |
201 | 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 |
202 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir |
199 | aio_readlink aio_fsync aio_fdatasync aio_readahead aio_rename aio_link |
203 | aio_scandir aio_symlink aio_readlink aio_sync aio_fsync |
|
|
204 | aio_fdatasync aio_pathsync aio_readahead |
|
|
205 | 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); |
206 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
|
|
207 | aio_chmod aio_utime aio_truncate); |
|
|
208 | |
201 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block)); |
209 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block)); |
202 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
210 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
203 | min_parallel max_parallel max_idle |
211 | min_parallel max_parallel max_idle |
204 | nreqs nready npending nthreads |
212 | nreqs nready npending nthreads |
205 | max_poll_time max_poll_reqs); |
213 | max_poll_time max_poll_reqs); |
… | |
… | |
271 | aio_read $_[0], ..., sub { |
279 | aio_read $_[0], ..., sub { |
272 | ... |
280 | ... |
273 | }; |
281 | }; |
274 | }; |
282 | }; |
275 | |
283 | |
|
|
284 | |
276 | =item aioreq_nice $pri_adjust |
285 | =item aioreq_nice $pri_adjust |
277 | |
286 | |
278 | Similar to C<aioreq_pri>, but subtracts the given value from the current |
287 | Similar to C<aioreq_pri>, but subtracts the given value from the current |
279 | priority, so the effect is cumulative. |
288 | priority, so the effect is cumulative. |
|
|
289 | |
280 | |
290 | |
281 | =item aio_open $pathname, $flags, $mode, $callback->($fh) |
291 | =item aio_open $pathname, $flags, $mode, $callback->($fh) |
282 | |
292 | |
283 | Asynchronously open or create a file and call the callback with a newly |
293 | Asynchronously open or create a file and call the callback with a newly |
284 | created filehandle for the file. |
294 | created filehandle for the file. |
… | |
… | |
305 | } else { |
315 | } else { |
306 | die "open failed: $!\n"; |
316 | die "open failed: $!\n"; |
307 | } |
317 | } |
308 | }; |
318 | }; |
309 | |
319 | |
|
|
320 | |
310 | =item aio_close $fh, $callback->($status) |
321 | =item aio_close $fh, $callback->($status) |
311 | |
322 | |
312 | Asynchronously close a file and call the callback with the result |
323 | Asynchronously close a file and call the callback with the result |
313 | code. I<WARNING:> although accepted, you should not pass in a perl |
324 | 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 | |
325 | |
318 | This is supposed to be a bug in the API, so that might change. It's |
326 | Unfortunately, you can't do this to perl. Perl I<insists> very strongly on |
319 | therefore best to avoid this function. |
327 | closing the file descriptor associated with the filehandle itself. |
|
|
328 | |
|
|
329 | Therefore, C<aio_close> will not close the filehandle - instead it will |
|
|
330 | use dup2 to overwrite the file descriptor with the write-end of a pipe |
|
|
331 | (the pipe fd will be created on demand and will be cached). |
|
|
332 | |
|
|
333 | Or in other words: the file descriptor will be closed, but it will not be |
|
|
334 | free for reuse until the perl filehandle is closed. |
|
|
335 | |
|
|
336 | =cut |
320 | |
337 | |
321 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
338 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
322 | |
339 | |
323 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
340 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
324 | |
341 | |
325 | Reads or writes C<length> bytes from the specified C<fh> and C<offset> |
342 | 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 |
343 | 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 |
344 | callback without the actual number of bytes read (or -1 on error, just |
328 | like the syscall). |
345 | like the syscall). |
329 | |
346 | |
|
|
347 | If C<$offset> is undefined, then the current file descriptor offset will |
|
|
348 | be used (and updated), otherwise the file descriptor offset will not be |
|
|
349 | changed by these calls. |
|
|
350 | |
|
|
351 | If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>. |
|
|
352 | |
|
|
353 | If C<$dataoffset> is less than zero, it will be counted from the end of |
|
|
354 | C<$data>. |
|
|
355 | |
330 | The C<$data> scalar I<MUST NOT> be modified in any way while the request |
356 | 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 |
357 | is outstanding. Modifying it can result in segfaults or World War III (if |
332 | necessary/optional hardware is installed). |
358 | the necessary/optional hardware is installed). |
333 | |
359 | |
334 | Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at |
360 | Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at |
335 | offset C<0> within the scalar: |
361 | offset C<0> within the scalar: |
336 | |
362 | |
337 | aio_read $fh, 7, 15, $buffer, 0, sub { |
363 | aio_read $fh, 7, 15, $buffer, 0, sub { |
338 | $_[0] > 0 or die "read error: $!"; |
364 | $_[0] > 0 or die "read error: $!"; |
339 | print "read $_[0] bytes: <$buffer>\n"; |
365 | print "read $_[0] bytes: <$buffer>\n"; |
340 | }; |
366 | }; |
|
|
367 | |
341 | |
368 | |
342 | =item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
369 | =item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
343 | |
370 | |
344 | Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts |
371 | 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 |
372 | 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 |
386 | 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 |
387 | 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 |
388 | 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 |
389 | value equals C<$length> one can assume that C<$length> bytes have been |
363 | read. |
390 | read. |
|
|
391 | |
364 | |
392 | |
365 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
393 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
366 | |
394 | |
367 | C<aio_readahead> populates the page cache with data from a file so that |
395 | 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> |
396 | 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. |
402 | file. The current file offset of the file is left unchanged. |
375 | |
403 | |
376 | If that syscall doesn't exist (likely if your OS isn't Linux) it will be |
404 | 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. |
405 | emulated by simply reading the data, which would have a similar effect. |
378 | |
406 | |
|
|
407 | |
379 | =item aio_stat $fh_or_path, $callback->($status) |
408 | =item aio_stat $fh_or_path, $callback->($status) |
380 | |
409 | |
381 | =item aio_lstat $fh, $callback->($status) |
410 | =item aio_lstat $fh, $callback->($status) |
382 | |
411 | |
383 | Works like perl's C<stat> or C<lstat> in void context. The callback will |
412 | Works like perl's C<stat> or C<lstat> in void context. The callback will |
… | |
… | |
396 | aio_stat "/etc/passwd", sub { |
425 | aio_stat "/etc/passwd", sub { |
397 | $_[0] and die "stat failed: $!"; |
426 | $_[0] and die "stat failed: $!"; |
398 | print "size is ", -s _, "\n"; |
427 | print "size is ", -s _, "\n"; |
399 | }; |
428 | }; |
400 | |
429 | |
|
|
430 | |
|
|
431 | =item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
|
|
432 | |
|
|
433 | Works like perl's C<utime> function (including the special case of $atime |
|
|
434 | and $mtime being undef). Fractional times are supported if the underlying |
|
|
435 | syscalls support them. |
|
|
436 | |
|
|
437 | When called with a pathname, uses utimes(2) if available, otherwise |
|
|
438 | utime(2). If called on a file descriptor, uses futimes(2) if available, |
|
|
439 | otherwise returns ENOSYS, so this is not portable. |
|
|
440 | |
|
|
441 | Examples: |
|
|
442 | |
|
|
443 | # set atime and mtime to current time (basically touch(1)): |
|
|
444 | aio_utime "path", undef, undef; |
|
|
445 | # set atime to current time and mtime to beginning of the epoch: |
|
|
446 | aio_utime "path", time, undef; # undef==0 |
|
|
447 | |
|
|
448 | |
|
|
449 | =item aio_chown $fh_or_path, $uid, $gid, $callback->($status) |
|
|
450 | |
|
|
451 | Works like perl's C<chown> function, except that C<undef> for either $uid |
|
|
452 | or $gid is being interpreted as "do not change" (but -1 can also be used). |
|
|
453 | |
|
|
454 | Examples: |
|
|
455 | |
|
|
456 | # same as "chown root path" in the shell: |
|
|
457 | aio_chown "path", 0, -1; |
|
|
458 | # same as above: |
|
|
459 | aio_chown "path", 0, undef; |
|
|
460 | |
|
|
461 | |
|
|
462 | =item aio_truncate $fh_or_path, $offset, $callback->($status) |
|
|
463 | |
|
|
464 | Works like truncate(2) or ftruncate(2). |
|
|
465 | |
|
|
466 | |
|
|
467 | =item aio_chmod $fh_or_path, $mode, $callback->($status) |
|
|
468 | |
|
|
469 | Works like perl's C<chmod> function. |
|
|
470 | |
|
|
471 | |
401 | =item aio_unlink $pathname, $callback->($status) |
472 | =item aio_unlink $pathname, $callback->($status) |
402 | |
473 | |
403 | Asynchronously unlink (delete) a file and call the callback with the |
474 | Asynchronously unlink (delete) a file and call the callback with the |
404 | result code. |
475 | result code. |
405 | |
476 | |
|
|
477 | |
406 | =item aio_mknod $path, $mode, $dev, $callback->($status) |
478 | =item aio_mknod $path, $mode, $dev, $callback->($status) |
407 | |
479 | |
408 | [EXPERIMENTAL] |
480 | [EXPERIMENTAL] |
409 | |
481 | |
410 | Asynchronously create a device node (or fifo). See mknod(2). |
482 | Asynchronously create a device node (or fifo). See mknod(2). |
411 | |
483 | |
412 | The only (POSIX-) portable way of calling this function is: |
484 | The only (POSIX-) portable way of calling this function is: |
413 | |
485 | |
414 | aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... |
486 | aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... |
|
|
487 | |
415 | |
488 | |
416 | =item aio_link $srcpath, $dstpath, $callback->($status) |
489 | =item aio_link $srcpath, $dstpath, $callback->($status) |
417 | |
490 | |
418 | Asynchronously create a new link to the existing object at C<$srcpath> at |
491 | 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. |
492 | the path C<$dstpath> and call the callback with the result code. |
420 | |
493 | |
|
|
494 | |
421 | =item aio_symlink $srcpath, $dstpath, $callback->($status) |
495 | =item aio_symlink $srcpath, $dstpath, $callback->($status) |
422 | |
496 | |
423 | Asynchronously create a new symbolic link to the existing object at C<$srcpath> at |
497 | 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. |
498 | the path C<$dstpath> and call the callback with the result code. |
|
|
499 | |
425 | |
500 | |
426 | =item aio_readlink $path, $callback->($link) |
501 | =item aio_readlink $path, $callback->($link) |
427 | |
502 | |
428 | Asynchronously read the symlink specified by C<$path> and pass it to |
503 | 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 |
504 | the callback. If an error occurs, nothing or undef gets passed to the |
430 | callback. |
505 | callback. |
431 | |
506 | |
|
|
507 | |
432 | =item aio_rename $srcpath, $dstpath, $callback->($status) |
508 | =item aio_rename $srcpath, $dstpath, $callback->($status) |
433 | |
509 | |
434 | Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as |
510 | Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as |
435 | rename(2) and call the callback with the result code. |
511 | rename(2) and call the callback with the result code. |
|
|
512 | |
436 | |
513 | |
437 | =item aio_mkdir $pathname, $mode, $callback->($status) |
514 | =item aio_mkdir $pathname, $mode, $callback->($status) |
438 | |
515 | |
439 | Asynchronously mkdir (create) a directory and call the callback with |
516 | 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 |
517 | 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. |
518 | request is executed, so do not change your umask. |
442 | |
519 | |
|
|
520 | |
443 | =item aio_rmdir $pathname, $callback->($status) |
521 | =item aio_rmdir $pathname, $callback->($status) |
444 | |
522 | |
445 | Asynchronously rmdir (delete) a directory and call the callback with the |
523 | Asynchronously rmdir (delete) a directory and call the callback with the |
446 | result code. |
524 | result code. |
|
|
525 | |
447 | |
526 | |
448 | =item aio_readdir $pathname, $callback->($entries) |
527 | =item aio_readdir $pathname, $callback->($entries) |
449 | |
528 | |
450 | Unlike the POSIX call of the same name, C<aio_readdir> reads an entire |
529 | 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 |
530 | directory (i.e. opendir + readdir + closedir). The entries will not be |
452 | sorted, and will B<NOT> include the C<.> and C<..> entries. |
531 | sorted, and will B<NOT> include the C<.> and C<..> entries. |
453 | |
532 | |
454 | The callback a single argument which is either C<undef> or an array-ref |
533 | The callback a single argument which is either C<undef> or an array-ref |
455 | with the filenames. |
534 | with the filenames. |
|
|
535 | |
456 | |
536 | |
457 | =item aio_load $path, $data, $callback->($status) |
537 | =item aio_load $path, $data, $callback->($status) |
458 | |
538 | |
459 | This is a composite request that tries to fully load the given file into |
539 | This is a composite request that tries to fully load the given file into |
460 | memory. Status is the same as with aio_read. |
540 | memory. Status is the same as with aio_read. |
… | |
… | |
524 | |
604 | |
525 | # those should not normally block. should. should. |
605 | # those should not normally block. should. should. |
526 | utime $stat[8], $stat[9], $dst; |
606 | utime $stat[8], $stat[9], $dst; |
527 | chmod $stat[2] & 07777, $dst_fh; |
607 | chmod $stat[2] & 07777, $dst_fh; |
528 | chown $stat[4], $stat[5], $dst_fh; |
608 | chown $stat[4], $stat[5], $dst_fh; |
|
|
609 | |
|
|
610 | aioreq_pri $pri; |
529 | close $dst_fh; |
611 | add $grp aio_close $dst_fh; |
530 | } else { |
612 | } else { |
531 | $grp->result (-1); |
613 | $grp->result (-1); |
532 | close $src_fh; |
614 | close $src_fh; |
533 | close $dst_fh; |
615 | close $dst_fh; |
534 | |
616 | |
… | |
… | |
767 | |
849 | |
768 | $grp |
850 | $grp |
769 | } |
851 | } |
770 | } |
852 | } |
771 | |
853 | |
|
|
854 | =item aio_sync $callback->($status) |
|
|
855 | |
|
|
856 | Asynchronously call sync and call the callback when finished. |
|
|
857 | |
772 | =item aio_fsync $fh, $callback->($status) |
858 | =item aio_fsync $fh, $callback->($status) |
773 | |
859 | |
774 | Asynchronously call fsync on the given filehandle and call the callback |
860 | Asynchronously call fsync on the given filehandle and call the callback |
775 | with the fsync result code. |
861 | with the fsync result code. |
776 | |
862 | |
… | |
… | |
779 | Asynchronously call fdatasync on the given filehandle and call the |
865 | Asynchronously call fdatasync on the given filehandle and call the |
780 | callback with the fdatasync result code. |
866 | callback with the fdatasync result code. |
781 | |
867 | |
782 | If this call isn't available because your OS lacks it or it couldn't be |
868 | 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. |
869 | detected, it will be emulated by calling C<fsync> instead. |
|
|
870 | |
|
|
871 | =item aio_pathsync $path, $callback->($status) |
|
|
872 | |
|
|
873 | This request tries to open, fsync and close the given path. This is a |
|
|
874 | composite request intended tosync directories after directory operations |
|
|
875 | (E.g. rename). This might not work on all operating systems or have any |
|
|
876 | specific effect, but usually it makes sure that directory changes get |
|
|
877 | written to disc. It works for anything that can be opened for read-only, |
|
|
878 | not just directories. |
|
|
879 | |
|
|
880 | Passes C<0> when everything went ok, and C<-1> on error. |
|
|
881 | |
|
|
882 | =cut |
|
|
883 | |
|
|
884 | sub aio_pathsync($;$) { |
|
|
885 | aio_block { |
|
|
886 | my ($path, $cb) = @_; |
|
|
887 | |
|
|
888 | my $pri = aioreq_pri; |
|
|
889 | my $grp = aio_group $cb; |
|
|
890 | |
|
|
891 | aioreq_pri $pri; |
|
|
892 | add $grp aio_open $path, O_RDONLY, 0, sub { |
|
|
893 | my ($fh) = @_; |
|
|
894 | if ($fh) { |
|
|
895 | aioreq_pri $pri; |
|
|
896 | add $grp aio_fsync $fh, sub { |
|
|
897 | $grp->result ($_[0]); |
|
|
898 | |
|
|
899 | aioreq_pri $pri; |
|
|
900 | add $grp aio_close $fh; |
|
|
901 | }; |
|
|
902 | } else { |
|
|
903 | $grp->result (-1); |
|
|
904 | } |
|
|
905 | }; |
|
|
906 | |
|
|
907 | $grp |
|
|
908 | } |
|
|
909 | } |
784 | |
910 | |
785 | =item aio_group $callback->(...) |
911 | =item aio_group $callback->(...) |
786 | |
912 | |
787 | This is a very special aio request: Instead of doing something, it is a |
913 | 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 |
914 | container for other aio requests, which is useful if you want to bundle |
… | |
… | |
925 | itself. Useful when you queued a lot of events but got a result early. |
1051 | itself. Useful when you queued a lot of events but got a result early. |
926 | |
1052 | |
927 | =item $grp->result (...) |
1053 | =item $grp->result (...) |
928 | |
1054 | |
929 | Set the result value(s) that will be passed to the group callback when all |
1055 | 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 |
1056 | 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, |
1057 | of errno (just like calling C<errno> without an error number). By default, |
932 | no argument will be passed and errno is zero. |
1058 | no argument will be passed and errno is zero. |
933 | |
1059 | |
934 | =item $grp->errno ([$errno]) |
1060 | =item $grp->errno ([$errno]) |
935 | |
1061 | |
… | |
… | |
1082 | |
1208 | |
1083 | =back |
1209 | =back |
1084 | |
1210 | |
1085 | =head3 CONTROLLING THE NUMBER OF THREADS |
1211 | =head3 CONTROLLING THE NUMBER OF THREADS |
1086 | |
1212 | |
|
|
1213 | =over |
|
|
1214 | |
1087 | =item IO::AIO::min_parallel $nthreads |
1215 | =item IO::AIO::min_parallel $nthreads |
1088 | |
1216 | |
1089 | Set the minimum number of AIO threads to C<$nthreads>. The current |
1217 | Set the minimum number of AIO threads to C<$nthreads>. The current |
1090 | default is C<8>, which means eight asynchronous operations can execute |
1218 | default is C<8>, which means eight asynchronous operations can execute |
1091 | concurrently at any one time (the number of outstanding requests, |
1219 | concurrently at any one time (the number of outstanding requests, |
… | |
… | |
1138 | This is a very bad function to use in interactive programs because it |
1266 | This is a very bad function to use in interactive programs because it |
1139 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1267 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1140 | use an C<aio_group> together with a feed callback. |
1268 | use an C<aio_group> together with a feed callback. |
1141 | |
1269 | |
1142 | Sets the maximum number of outstanding requests to C<$nreqs>. If you |
1270 | Sets the maximum number of outstanding requests to C<$nreqs>. If you |
1143 | to queue up more than this number of requests, the next call to the |
1271 | do queue up more than this number of requests, the next call to the |
1144 | C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>) |
1272 | C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>) |
1145 | function will block until the limit is no longer exceeded. |
1273 | function will block until the limit is no longer exceeded. |
1146 | |
1274 | |
1147 | The default value is very large, so there is no practical limit on the |
1275 | The default value is very large, so there is no practical limit on the |
1148 | number of outstanding requests. |
1276 | number of outstanding requests. |
… | |
… | |
1178 | but not yet processed by poll_cb). |
1306 | but not yet processed by poll_cb). |
1179 | |
1307 | |
1180 | =back |
1308 | =back |
1181 | |
1309 | |
1182 | =cut |
1310 | =cut |
1183 | |
|
|
1184 | # support function to convert a fd into a perl filehandle |
|
|
1185 | sub _fd2fh { |
|
|
1186 | return undef if $_[0] < 0; |
|
|
1187 | |
|
|
1188 | # try to generate nice filehandles |
|
|
1189 | my $sym = "IO::AIO::fd#$_[0]"; |
|
|
1190 | local *$sym; |
|
|
1191 | |
|
|
1192 | open *$sym, "+<&=$_[0]" # usually works under any unix |
|
|
1193 | or open *$sym, "<&=$_[0]" # cygwin needs this |
|
|
1194 | or open *$sym, ">&=$_[0]" # or this |
|
|
1195 | or return undef; |
|
|
1196 | |
|
|
1197 | *$sym |
|
|
1198 | } |
|
|
1199 | |
1311 | |
1200 | min_parallel 8; |
1312 | min_parallel 8; |
1201 | |
1313 | |
1202 | END { flush } |
1314 | END { flush } |
1203 | |
1315 | |
… | |
… | |
1227 | bytes of memory. In addition, stat requests need a stat buffer (possibly |
1339 | bytes of memory. In addition, stat requests need a stat buffer (possibly |
1228 | a few hundred bytes), readdir requires a result buffer and so on. Perl |
1340 | a few hundred bytes), readdir requires a result buffer and so on. Perl |
1229 | scalars and other data passed into aio requests will also be locked and |
1341 | scalars and other data passed into aio requests will also be locked and |
1230 | will consume memory till the request has entered the done state. |
1342 | will consume memory till the request has entered the done state. |
1231 | |
1343 | |
1232 | This is now awfully much, so queuing lots of requests is not usually a |
1344 | This is not awfully much, so queuing lots of requests is not usually a |
1233 | problem. |
1345 | problem. |
1234 | |
1346 | |
1235 | Per-thread usage: |
1347 | Per-thread usage: |
1236 | |
1348 | |
1237 | In the execution phase, some aio requests require more memory for |
1349 | In the execution phase, some aio requests require more memory for |