… | |
… | |
24 | $req->cancel; # cancel request if still in queue |
24 | $req->cancel; # cancel request if still in queue |
25 | |
25 | |
26 | my $grp = aio_group sub { print "all stats done\n" }; |
26 | my $grp = aio_group sub { print "all stats done\n" }; |
27 | add $grp aio_stat "..." for ...; |
27 | add $grp aio_stat "..." for ...; |
28 | |
28 | |
|
|
29 | # AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...) |
|
|
30 | use AnyEvent::AIO; |
|
|
31 | |
29 | # AnyEvent integration |
32 | # EV integration |
30 | open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!"; |
33 | my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; |
31 | my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb }); |
|
|
32 | |
34 | |
33 | # Event integration |
35 | # Event integration |
34 | Event->io (fd => IO::AIO::poll_fileno, |
36 | Event->io (fd => IO::AIO::poll_fileno, |
35 | poll => 'r', |
37 | poll => 'r', |
36 | cb => \&IO::AIO::poll_cb); |
38 | cb => \&IO::AIO::poll_cb); |
… | |
… | |
173 | All the "aio_*" calls are more or less thin wrappers around the syscall |
175 | All the "aio_*" calls are more or less thin wrappers around the syscall |
174 | with the same name (sans "aio_"). The arguments are similar or |
176 | with the same name (sans "aio_"). The arguments are similar or |
175 | identical, and they all accept an additional (and optional) $callback |
177 | identical, and they all accept an additional (and optional) $callback |
176 | argument which must be a code reference. This code reference will get |
178 | argument which must be a code reference. This code reference will get |
177 | called with the syscall return code (e.g. most syscalls return -1 on |
179 | called with the syscall return code (e.g. most syscalls return -1 on |
178 | error, unlike perl, which usually delivers "false") as it's sole |
180 | error, unlike perl, which usually delivers "false") as its sole argument |
179 | argument when the given syscall has been executed asynchronously. |
181 | after the given syscall has been executed asynchronously. |
180 | |
182 | |
181 | All functions expecting a filehandle keep a copy of the filehandle |
183 | All functions expecting a filehandle keep a copy of the filehandle |
182 | internally until the request has finished. |
184 | internally until the request has finished. |
183 | |
185 | |
184 | All functions return request objects of type IO::AIO::REQ that allow |
186 | All functions return request objects of type IO::AIO::REQ that allow |
… | |
… | |
197 | the user environment, d) use Glib::filename_from_unicode on unicode |
199 | the user environment, d) use Glib::filename_from_unicode on unicode |
198 | filenames or e) use something else to ensure your scalar has the correct |
200 | filenames or e) use something else to ensure your scalar has the correct |
199 | contents. |
201 | contents. |
200 | |
202 | |
201 | This works, btw. independent of the internal UTF-8 bit, which IO::AIO |
203 | This works, btw. independent of the internal UTF-8 bit, which IO::AIO |
202 | handles correctly wether it is set or not. |
204 | handles correctly whether it is set or not. |
203 | |
205 | |
204 | $prev_pri = aioreq_pri [$pri] |
206 | $prev_pri = aioreq_pri [$pri] |
205 | Returns the priority value that would be used for the next request |
207 | Returns the priority value that would be used for the next request |
206 | and, if $pri is given, sets the priority for the next aio request. |
208 | and, if $pri is given, sets the priority for the next aio request. |
207 | |
209 | |
… | |
… | |
258 | } |
260 | } |
259 | }; |
261 | }; |
260 | |
262 | |
261 | aio_close $fh, $callback->($status) |
263 | aio_close $fh, $callback->($status) |
262 | Asynchronously close a file and call the callback with the result |
264 | Asynchronously close a file and call the callback with the result |
263 | code. *WARNING:* although accepted, you should not pass in a perl |
265 | code. |
264 | filehandle here, as perl will likely close the file descriptor |
|
|
265 | another time when the filehandle is destroyed. Normally, you can |
|
|
266 | safely call perls "close" or just let filehandles go out of scope. |
|
|
267 | |
266 | |
268 | This is supposed to be a bug in the API, so that might change. It's |
267 | Unfortunately, you can't do this to perl. Perl *insists* very |
269 | therefore best to avoid this function. |
268 | strongly on closing the file descriptor associated with the |
|
|
269 | filehandle itself. |
|
|
270 | |
|
|
271 | Therefore, "aio_close" will not close the filehandle - instead it |
|
|
272 | will use dup2 to overwrite the file descriptor with the write-end of |
|
|
273 | a pipe (the pipe fd will be created on demand and will be cached). |
|
|
274 | |
|
|
275 | Or in other words: the file descriptor will be closed, but it will |
|
|
276 | not be free for reuse until the perl filehandle is closed. |
270 | |
277 | |
271 | aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
278 | aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
272 | aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
279 | aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
273 | Reads or writes $length bytes from the specified $fh and $offset |
280 | Reads or writes $length bytes from the specified $fh and $offset |
274 | into the scalar given by $data and offset $dataoffset and calls the |
281 | into the scalar given by $data and offset $dataoffset and calls the |
275 | callback without the actual number of bytes read (or -1 on error, |
282 | callback without the actual number of bytes read (or -1 on error, |
276 | just like the syscall). |
283 | just like the syscall). |
277 | |
284 | |
278 | If $offset is undefined, then the current file offset will be used |
285 | If $offset is undefined, then the current file descriptor offset |
279 | (and updated), otherwise the file offset will not be changed by |
286 | will be used (and updated), otherwise the file descriptor offset |
280 | these calls. |
287 | will not be changed by these calls. |
281 | |
288 | |
282 | If $length is undefined in "aio_write", use the remaining length of |
289 | If $length is undefined in "aio_write", use the remaining length of |
283 | $data. |
290 | $data. |
284 | |
291 | |
285 | If $dataoffset is less than zero, it will be counted from the end of |
292 | If $dataoffset is less than zero, it will be counted from the end of |
… | |
… | |
444 | aio_copy $srcpath, $dstpath, $callback->($status) |
451 | aio_copy $srcpath, $dstpath, $callback->($status) |
445 | Try to copy the *file* (directories not supported as either source |
452 | Try to copy the *file* (directories not supported as either source |
446 | or destination) from $srcpath to $dstpath and call the callback with |
453 | or destination) from $srcpath to $dstpath and call the callback with |
447 | the 0 (error) or -1 ok. |
454 | the 0 (error) or -1 ok. |
448 | |
455 | |
449 | This is a composite request that it creates the destination file |
456 | This is a composite request that creates the destination file with |
450 | with mode 0200 and copies the contents of the source file into it |
457 | mode 0200 and copies the contents of the source file into it using |
451 | using "aio_sendfile", followed by restoring atime, mtime, access |
458 | "aio_sendfile", followed by restoring atime, mtime, access mode and |
452 | mode and uid/gid, in that order. |
459 | uid/gid, in that order. |
453 | |
460 | |
454 | If an error occurs, the partial destination file will be unlinked, |
461 | If an error occurs, the partial destination file will be unlinked, |
455 | if possible, except when setting atime, mtime, access mode and |
462 | if possible, except when setting atime, mtime, access mode and |
456 | uid/gid, where errors are being ignored. |
463 | uid/gid, where errors are being ignored. |
457 | |
464 | |
458 | aio_move $srcpath, $dstpath, $callback->($status) |
465 | aio_move $srcpath, $dstpath, $callback->($status) |
459 | Try to move the *file* (directories not supported as either source |
466 | Try to move the *file* (directories not supported as either source |
460 | or destination) from $srcpath to $dstpath and call the callback with |
467 | or destination) from $srcpath to $dstpath and call the callback with |
461 | the 0 (error) or -1 ok. |
468 | the 0 (error) or -1 ok. |
462 | |
469 | |
463 | This is a composite request that tries to rename(2) the file first. |
470 | This is a composite request that tries to rename(2) the file first; |
464 | If rename files with "EXDEV", it copies the file with "aio_copy" |
471 | if rename fails with "EXDEV", it copies the file with "aio_copy" |
465 | and, if that is successful, unlinking the $srcpath. |
472 | and, if that is successful, unlinks the $srcpath. |
466 | |
473 | |
467 | aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
474 | aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
468 | Scans a directory (similar to "aio_readdir") but additionally tries |
475 | Scans a directory (similar to "aio_readdir") but additionally tries |
469 | to efficiently separate the entries of directory $path into two sets |
476 | to efficiently separate the entries of directory $path into two sets |
470 | of names, directories you can recurse into (directories), and ones |
477 | of names, directories you can recurse into (directories), and ones |
… | |
… | |
521 | Delete a directory tree starting (and including) $path, return the |
528 | Delete a directory tree starting (and including) $path, return the |
522 | status of the final "rmdir" only. This is a composite request that |
529 | status of the final "rmdir" only. This is a composite request that |
523 | uses "aio_scandir" to recurse into and rmdir directories, and unlink |
530 | uses "aio_scandir" to recurse into and rmdir directories, and unlink |
524 | everything else. |
531 | everything else. |
525 | |
532 | |
|
|
533 | aio_sync $callback->($status) |
|
|
534 | Asynchronously call sync and call the callback when finished. |
|
|
535 | |
526 | aio_fsync $fh, $callback->($status) |
536 | aio_fsync $fh, $callback->($status) |
527 | Asynchronously call fsync on the given filehandle and call the |
537 | Asynchronously call fsync on the given filehandle and call the |
528 | callback with the fsync result code. |
538 | callback with the fsync result code. |
529 | |
539 | |
530 | aio_fdatasync $fh, $callback->($status) |
540 | aio_fdatasync $fh, $callback->($status) |
531 | Asynchronously call fdatasync on the given filehandle and call the |
541 | Asynchronously call fdatasync on the given filehandle and call the |
532 | callback with the fdatasync result code. |
542 | callback with the fdatasync result code. |
533 | |
543 | |
534 | If this call isn't available because your OS lacks it or it couldn't |
544 | If this call isn't available because your OS lacks it or it couldn't |
535 | be detected, it will be emulated by calling "fsync" instead. |
545 | be detected, it will be emulated by calling "fsync" instead. |
|
|
546 | |
|
|
547 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
|
|
548 | Sync the data portion of the file specified by $offset and $length |
|
|
549 | to disk (but NOT the metadata), by calling the Linux-specific |
|
|
550 | sync_file_range call. If sync_file_range is not available or it |
|
|
551 | returns ENOSYS, then fdatasync or fsync is being substituted. |
|
|
552 | |
|
|
553 | $flags can be a combination of |
|
|
554 | "IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE", |
|
|
555 | "IO::AIO::SYNC_FILE_RANGE_WRITE" and |
|
|
556 | "IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER": refer to the sync_file_range |
|
|
557 | manpage for details. |
|
|
558 | |
|
|
559 | aio_pathsync $path, $callback->($status) |
|
|
560 | This request tries to open, fsync and close the given path. This is |
|
|
561 | a composite request intended to sync directories after directory |
|
|
562 | operations (E.g. rename). This might not work on all operating |
|
|
563 | systems or have any specific effect, but usually it makes sure that |
|
|
564 | directory changes get written to disc. It works for anything that |
|
|
565 | can be opened for read-only, not just directories. |
|
|
566 | |
|
|
567 | Passes 0 when everything went ok, and -1 on error. |
536 | |
568 | |
537 | aio_group $callback->(...) |
569 | aio_group $callback->(...) |
538 | This is a very special aio request: Instead of doing something, it |
570 | This is a very special aio request: Instead of doing something, it |
539 | is a container for other aio requests, which is useful if you want |
571 | is a container for other aio requests, which is useful if you want |
540 | to bundle many requests into a single, composite, request with a |
572 | to bundle many requests into a single, composite, request with a |
… | |
… | |
622 | }; |
654 | }; |
623 | |
655 | |
624 | This makes it very easy to create composite requests (see the source of |
656 | This makes it very easy to create composite requests (see the source of |
625 | "aio_move" for an application) that work and feel like simple requests. |
657 | "aio_move" for an application) that work and feel like simple requests. |
626 | |
658 | |
627 | * The IO::AIO::GRP objects will be cleaned up during calls to |
659 | * The IO::AIO::GRP objects will be cleaned up during calls to |
628 | "IO::AIO::poll_cb", just like any other request. |
660 | "IO::AIO::poll_cb", just like any other request. |
|
|
661 | |
629 | * They can be canceled like any other request. Canceling will cancel not |
662 | * They can be canceled like any other request. Canceling will cancel |
630 | only the request itself, but also all requests it contains. |
663 | not only the request itself, but also all requests it contains. |
|
|
664 | |
631 | * They can also can also be added to other IO::AIO::GRP objects. |
665 | * They can also can also be added to other IO::AIO::GRP objects. |
|
|
666 | |
632 | * You must not add requests to a group from within the group callback |
667 | * You must not add requests to a group from within the group callback |
633 | (or any later time). |
668 | (or any later time). |
634 | |
669 | |
635 | Their lifetime, simplified, looks like this: when they are empty, they |
670 | Their lifetime, simplified, looks like this: when they are empty, they |
636 | will finish very quickly. If they contain only requests that are in the |
671 | will finish very quickly. If they contain only requests that are in the |
637 | "done" state, they will also finish. Otherwise they will continue to |
672 | "done" state, they will also finish. Otherwise they will continue to |
638 | exist. |
673 | exist. |
639 | |
674 | |
640 | That means after creating a group you have some time to add requests. |
675 | That means after creating a group you have some time to add requests |
641 | And in the callbacks of those requests, you can add further requests to |
676 | (precisely before the callback has been invoked, which is only done |
642 | the group. And only when all those requests have finished will the the |
677 | within the "poll_cb"). And in the callbacks of those requests, you can |
643 | group itself finish. |
678 | add further requests to the group. And only when all those requests have |
|
|
679 | finished will the the group itself finish. |
644 | |
680 | |
645 | add $grp ... |
681 | add $grp ... |
646 | $grp->add (...) |
682 | $grp->add (...) |
647 | Add one or more requests to the group. Any type of IO::AIO::REQ can |
683 | Add one or more requests to the group. Any type of IO::AIO::REQ can |
648 | be added, including other groups, as long as you do not create |
684 | be added, including other groups, as long as you do not create |
… | |
… | |
655 | request itself. Useful when you queued a lot of events but got a |
691 | request itself. Useful when you queued a lot of events but got a |
656 | result early. |
692 | result early. |
657 | |
693 | |
658 | $grp->result (...) |
694 | $grp->result (...) |
659 | Set the result value(s) that will be passed to the group callback |
695 | Set the result value(s) that will be passed to the group callback |
660 | when all subrequests have finished and set thre groups errno to the |
696 | when all subrequests have finished and set the groups errno to the |
661 | current value of errno (just like calling "errno" without an error |
697 | current value of errno (just like calling "errno" without an error |
662 | number). By default, no argument will be passed and errno is zero. |
698 | number). By default, no argument will be passed and errno is zero. |
663 | |
699 | |
664 | $grp->errno ([$errno]) |
700 | $grp->errno ([$errno]) |
665 | Sets the group errno value to $errno, or the current value of errno |
701 | Sets the group errno value to $errno, or the current value of errno |
… | |
… | |
691 | does not impose any limits). |
727 | does not impose any limits). |
692 | |
728 | |
693 | If the feed does not queue more requests when called, it will be |
729 | If the feed does not queue more requests when called, it will be |
694 | automatically removed from the group. |
730 | automatically removed from the group. |
695 | |
731 | |
696 | If the feed limit is 0, it will be set to 2 automatically. |
732 | If the feed limit is 0 when this method is called, it will be set to |
|
|
733 | 2 automatically. |
697 | |
734 | |
698 | Example: |
735 | Example: |
699 | |
736 | |
700 | # stat all files in @files, but only ever use four aio requests concurrently: |
737 | # stat all files in @files, but only ever use four aio requests concurrently: |
701 | |
738 | |
… | |
… | |
711 | limit $grp $num |
748 | limit $grp $num |
712 | Sets the feeder limit for the group: The feeder will be called |
749 | Sets the feeder limit for the group: The feeder will be called |
713 | whenever the group contains less than this many requests. |
750 | whenever the group contains less than this many requests. |
714 | |
751 | |
715 | Setting the limit to 0 will pause the feeding process. |
752 | Setting the limit to 0 will pause the feeding process. |
|
|
753 | |
|
|
754 | The default value for the limit is 0, but note that setting a feeder |
|
|
755 | automatically bumps it up to 2. |
716 | |
756 | |
717 | SUPPORT FUNCTIONS |
757 | SUPPORT FUNCTIONS |
718 | EVENT PROCESSING AND EVENT LOOP INTEGRATION |
758 | EVENT PROCESSING AND EVENT LOOP INTEGRATION |
719 | $fileno = IO::AIO::poll_fileno |
759 | $fileno = IO::AIO::poll_fileno |
720 | Return the *request result pipe file descriptor*. This filehandle |
760 | Return the *request result pipe file descriptor*. This filehandle |
… | |
… | |
724 | |
764 | |
725 | See "poll_cb" for an example. |
765 | See "poll_cb" for an example. |
726 | |
766 | |
727 | IO::AIO::poll_cb |
767 | IO::AIO::poll_cb |
728 | Process some outstanding events on the result pipe. You have to call |
768 | Process some outstanding events on the result pipe. You have to call |
729 | this regularly. Returns the number of events processed. Returns |
769 | this regularly. Returns 0 if all events could be processed, or -1 if |
730 | immediately when no events are outstanding. The amount of events |
770 | it returned earlier for whatever reason. Returns immediately when no |
|
|
771 | events are outstanding. The amount of events processed depends on |
731 | processed depends on the settings of "IO::AIO::max_poll_req" and |
772 | the settings of "IO::AIO::max_poll_req" and |
732 | "IO::AIO::max_poll_time". |
773 | "IO::AIO::max_poll_time". |
733 | |
774 | |
734 | If not all requests were processed for whatever reason, the |
775 | If not all requests were processed for whatever reason, the |
735 | filehandle will still be ready when "poll_cb" returns. |
776 | filehandle will still be ready when "poll_cb" returns, so normally |
|
|
777 | you don't have to do anything special to have it called later. |
736 | |
778 | |
737 | Example: Install an Event watcher that automatically calls |
779 | Example: Install an Event watcher that automatically calls |
738 | IO::AIO::poll_cb with high priority: |
780 | IO::AIO::poll_cb with high priority: |
739 | |
781 | |
740 | Event->io (fd => IO::AIO::poll_fileno, |
782 | Event->io (fd => IO::AIO::poll_fileno, |
… | |
… | |
846 | |
888 | |
847 | The default is probably ok in most situations, especially if thread |
889 | The default is probably ok in most situations, especially if thread |
848 | creation is fast. If thread creation is very slow on your system you |
890 | creation is fast. If thread creation is very slow on your system you |
849 | might want to use larger values. |
891 | might want to use larger values. |
850 | |
892 | |
851 | $oldmaxreqs = IO::AIO::max_outstanding $maxreqs |
893 | IO::AIO::max_outstanding $maxreqs |
852 | This is a very bad function to use in interactive programs because |
894 | This is a very bad function to use in interactive programs because |
853 | it blocks, and a bad way to reduce concurrency because it is |
895 | it blocks, and a bad way to reduce concurrency because it is |
854 | inexact: Better use an "aio_group" together with a feed callback. |
896 | inexact: Better use an "aio_group" together with a feed callback. |
855 | |
897 | |
856 | Sets the maximum number of outstanding requests to $nreqs. If you to |
898 | Sets the maximum number of outstanding requests to $nreqs. If you do |
857 | queue up more than this number of requests, the next call to the |
899 | queue up more than this number of requests, the next call to the |
858 | "poll_cb" (and "poll_some" and other functions calling "poll_cb") |
900 | "poll_cb" (and "poll_some" and other functions calling "poll_cb") |
859 | function will block until the limit is no longer exceeded. |
901 | function will block until the limit is no longer exceeded. |
860 | |
902 | |
861 | The default value is very large, so there is no practical limit on |
903 | The default value is very large, so there is no practical limit on |
862 | the number of outstanding requests. |
904 | the number of outstanding requests. |
863 | |
905 | |
864 | You can still queue as many requests as you want. Therefore, |
906 | You can still queue as many requests as you want. Therefore, |
865 | "max_oustsanding" is mainly useful in simple scripts (with low |
907 | "max_outstanding" is mainly useful in simple scripts (with low |
866 | values) or as a stop gap to shield against fatal memory overflow |
908 | values) or as a stop gap to shield against fatal memory overflow |
867 | (with large values). |
909 | (with large values). |
868 | |
910 | |
869 | STATISTICAL INFORMATION |
911 | STATISTICAL INFORMATION |
870 | IO::AIO::nreqs |
912 | IO::AIO::nreqs |
… | |
… | |
907 | bytes of memory. In addition, stat requests need a stat buffer (possibly |
949 | bytes of memory. In addition, stat requests need a stat buffer (possibly |
908 | a few hundred bytes), readdir requires a result buffer and so on. Perl |
950 | a few hundred bytes), readdir requires a result buffer and so on. Perl |
909 | scalars and other data passed into aio requests will also be locked and |
951 | scalars and other data passed into aio requests will also be locked and |
910 | will consume memory till the request has entered the done state. |
952 | will consume memory till the request has entered the done state. |
911 | |
953 | |
912 | This is now awfully much, so queuing lots of requests is not usually a |
954 | This is not awfully much, so queuing lots of requests is not usually a |
913 | problem. |
955 | problem. |
914 | |
956 | |
915 | Per-thread usage: |
957 | Per-thread usage: |
916 | |
958 | |
917 | In the execution phase, some aio requests require more memory for |
959 | In the execution phase, some aio requests require more memory for |
… | |
… | |
920 | |
962 | |
921 | KNOWN BUGS |
963 | KNOWN BUGS |
922 | Known bugs will be fixed in the next release. |
964 | Known bugs will be fixed in the next release. |
923 | |
965 | |
924 | SEE ALSO |
966 | SEE ALSO |
925 | Coro::AIO. |
967 | AnyEvent::AIO for easy integration into event loops, Coro::AIO for a |
|
|
968 | more natural syntax. |
926 | |
969 | |
927 | AUTHOR |
970 | AUTHOR |
928 | Marc Lehmann <schmorp@schmorp.de> |
971 | Marc Lehmann <schmorp@schmorp.de> |
929 | http://home.schmorp.de/ |
972 | http://home.schmorp.de/ |
930 | |
973 | |