… | |
… | |
193 | use strict 'vars'; |
193 | use strict 'vars'; |
194 | |
194 | |
195 | use base 'Exporter'; |
195 | use base 'Exporter'; |
196 | |
196 | |
197 | BEGIN { |
197 | BEGIN { |
198 | our $VERSION = '3.02'; |
198 | our $VERSION = '3.16'; |
199 | |
199 | |
200 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close |
200 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close |
201 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir |
201 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir |
202 | aio_scandir aio_symlink aio_readlink aio_sync aio_fsync |
202 | aio_scandir aio_symlink aio_readlink aio_sync aio_fsync |
203 | aio_fdatasync aio_pathsync aio_readahead |
203 | aio_fdatasync aio_pathsync aio_readahead |
… | |
… | |
224 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
224 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
225 | with the same name (sans C<aio_>). The arguments are similar or identical, |
225 | with the same name (sans C<aio_>). The arguments are similar or identical, |
226 | and they all accept an additional (and optional) C<$callback> argument |
226 | and they all accept an additional (and optional) C<$callback> argument |
227 | which must be a code reference. This code reference will get called with |
227 | which must be a code reference. This code reference will get called with |
228 | the syscall return code (e.g. most syscalls return C<-1> on error, unlike |
228 | the syscall return code (e.g. most syscalls return C<-1> on error, unlike |
229 | perl, which usually delivers "false") as it's sole argument when the given |
229 | perl, which usually delivers "false") as its sole argument after the given |
230 | syscall has been executed asynchronously. |
230 | syscall has been executed asynchronously. |
231 | |
231 | |
232 | All functions expecting a filehandle keep a copy of the filehandle |
232 | All functions expecting a filehandle keep a copy of the filehandle |
233 | internally until the request has finished. |
233 | internally until the request has finished. |
234 | |
234 | |
… | |
… | |
248 | your pathnames to the locale (or other) encoding in effect in the user |
248 | your pathnames to the locale (or other) encoding in effect in the user |
249 | environment, d) use Glib::filename_from_unicode on unicode filenames or e) |
249 | environment, d) use Glib::filename_from_unicode on unicode filenames or e) |
250 | use something else to ensure your scalar has the correct contents. |
250 | use something else to ensure your scalar has the correct contents. |
251 | |
251 | |
252 | This works, btw. independent of the internal UTF-8 bit, which IO::AIO |
252 | This works, btw. independent of the internal UTF-8 bit, which IO::AIO |
253 | handles correctly wether it is set or not. |
253 | handles correctly whether it is set or not. |
254 | |
254 | |
255 | =over 4 |
255 | =over 4 |
256 | |
256 | |
257 | =item $prev_pri = aioreq_pri [$pri] |
257 | =item $prev_pri = aioreq_pri [$pri] |
258 | |
258 | |
… | |
… | |
565 | |
565 | |
566 | Try to copy the I<file> (directories not supported as either source or |
566 | Try to copy the I<file> (directories not supported as either source or |
567 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
567 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
568 | the C<0> (error) or C<-1> ok. |
568 | the C<0> (error) or C<-1> ok. |
569 | |
569 | |
570 | This is a composite request that it creates the destination file with |
570 | This is a composite request that creates the destination file with |
571 | mode 0200 and copies the contents of the source file into it using |
571 | mode 0200 and copies the contents of the source file into it using |
572 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
572 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
573 | uid/gid, in that order. |
573 | uid/gid, in that order. |
574 | |
574 | |
575 | If an error occurs, the partial destination file will be unlinked, if |
575 | If an error occurs, the partial destination file will be unlinked, if |
… | |
… | |
631 | |
631 | |
632 | Try to move the I<file> (directories not supported as either source or |
632 | Try to move the I<file> (directories not supported as either source or |
633 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
633 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
634 | the C<0> (error) or C<-1> ok. |
634 | the C<0> (error) or C<-1> ok. |
635 | |
635 | |
636 | This is a composite request that tries to rename(2) the file first. If |
636 | This is a composite request that tries to rename(2) the file first; if |
637 | rename files with C<EXDEV>, it copies the file with C<aio_copy> and, if |
637 | rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if |
638 | that is successful, unlinking the C<$srcpath>. |
638 | that is successful, unlinks the C<$srcpath>. |
639 | |
639 | |
640 | =cut |
640 | =cut |
641 | |
641 | |
642 | sub aio_move($$;$) { |
642 | sub aio_move($$;$) { |
643 | my ($src, $dst, $cb) = @_; |
643 | my ($src, $dst, $cb) = @_; |
… | |
… | |
858 | detected, it will be emulated by calling C<fsync> instead. |
858 | detected, it will be emulated by calling C<fsync> instead. |
859 | |
859 | |
860 | =item aio_pathsync $path, $callback->($status) |
860 | =item aio_pathsync $path, $callback->($status) |
861 | |
861 | |
862 | This request tries to open, fsync and close the given path. This is a |
862 | This request tries to open, fsync and close the given path. This is a |
863 | composite request intended tosync directories after directory operations |
863 | composite request intended to sync directories after directory operations |
864 | (E.g. rename). This might not work on all operating systems or have any |
864 | (E.g. rename). This might not work on all operating systems or have any |
865 | specific effect, but usually it makes sure that directory changes get |
865 | specific effect, but usually it makes sure that directory changes get |
866 | written to disc. It works for anything that can be opened for read-only, |
866 | written to disc. It works for anything that can be opened for read-only, |
867 | not just directories. |
867 | not just directories. |
868 | |
868 | |
… | |
… | |
1013 | Their lifetime, simplified, looks like this: when they are empty, they |
1013 | Their lifetime, simplified, looks like this: when they are empty, they |
1014 | will finish very quickly. If they contain only requests that are in the |
1014 | will finish very quickly. If they contain only requests that are in the |
1015 | C<done> state, they will also finish. Otherwise they will continue to |
1015 | C<done> state, they will also finish. Otherwise they will continue to |
1016 | exist. |
1016 | exist. |
1017 | |
1017 | |
1018 | That means after creating a group you have some time to add requests. And |
1018 | That means after creating a group you have some time to add requests |
1019 | in the callbacks of those requests, you can add further requests to the |
1019 | (precisely before the callback has been invoked, which is only done within |
1020 | group. And only when all those requests have finished will the the group |
1020 | the C<poll_cb>). And in the callbacks of those requests, you can add |
1021 | itself finish. |
1021 | further requests to the group. And only when all those requests have |
|
|
1022 | finished will the the group itself finish. |
1022 | |
1023 | |
1023 | =over 4 |
1024 | =over 4 |
1024 | |
1025 | |
1025 | =item add $grp ... |
1026 | =item add $grp ... |
1026 | |
1027 | |
… | |
… | |
1059 | =item feed $grp $callback->($grp) |
1060 | =item feed $grp $callback->($grp) |
1060 | |
1061 | |
1061 | Sets a feeder/generator on this group: every group can have an attached |
1062 | Sets a feeder/generator on this group: every group can have an attached |
1062 | generator that generates requests if idle. The idea behind this is that, |
1063 | generator that generates requests if idle. The idea behind this is that, |
1063 | although you could just queue as many requests as you want in a group, |
1064 | although you could just queue as many requests as you want in a group, |
1064 | this might starve other requests for a potentially long time. For |
1065 | this might starve other requests for a potentially long time. For example, |
1065 | example, C<aio_scandir> might generate hundreds of thousands C<aio_stat> |
1066 | C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests, |
1066 | requests, delaying any later requests for a long time. |
1067 | delaying any later requests for a long time. |
1067 | |
1068 | |
1068 | To avoid this, and allow incremental generation of requests, you can |
1069 | To avoid this, and allow incremental generation of requests, you can |
1069 | instead a group and set a feeder on it that generates those requests. The |
1070 | instead a group and set a feeder on it that generates those requests. The |
1070 | feed callback will be called whenever there are few enough (see C<limit>, |
1071 | feed callback will be called whenever there are few enough (see C<limit>, |
1071 | below) requests active in the group itself and is expected to queue more |
1072 | below) requests active in the group itself and is expected to queue more |
… | |
… | |
1075 | not impose any limits). |
1076 | not impose any limits). |
1076 | |
1077 | |
1077 | If the feed does not queue more requests when called, it will be |
1078 | If the feed does not queue more requests when called, it will be |
1078 | automatically removed from the group. |
1079 | automatically removed from the group. |
1079 | |
1080 | |
1080 | If the feed limit is C<0>, it will be set to C<2> automatically. |
1081 | If the feed limit is C<0> when this method is called, it will be set to |
|
|
1082 | C<2> automatically. |
1081 | |
1083 | |
1082 | Example: |
1084 | Example: |
1083 | |
1085 | |
1084 | # stat all files in @files, but only ever use four aio requests concurrently: |
1086 | # stat all files in @files, but only ever use four aio requests concurrently: |
1085 | |
1087 | |
… | |
… | |
1097 | Sets the feeder limit for the group: The feeder will be called whenever |
1099 | Sets the feeder limit for the group: The feeder will be called whenever |
1098 | the group contains less than this many requests. |
1100 | the group contains less than this many requests. |
1099 | |
1101 | |
1100 | Setting the limit to C<0> will pause the feeding process. |
1102 | Setting the limit to C<0> will pause the feeding process. |
1101 | |
1103 | |
|
|
1104 | The default value for the limit is C<0>, but note that setting a feeder |
|
|
1105 | automatically bumps it up to C<2>. |
|
|
1106 | |
1102 | =back |
1107 | =back |
1103 | |
1108 | |
1104 | =head2 SUPPORT FUNCTIONS |
1109 | =head2 SUPPORT FUNCTIONS |
1105 | |
1110 | |
1106 | =head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION |
1111 | =head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION |
… | |
… | |
1117 | See C<poll_cb> for an example. |
1122 | See C<poll_cb> for an example. |
1118 | |
1123 | |
1119 | =item IO::AIO::poll_cb |
1124 | =item IO::AIO::poll_cb |
1120 | |
1125 | |
1121 | Process some outstanding events on the result pipe. You have to call this |
1126 | Process some outstanding events on the result pipe. You have to call this |
1122 | regularly. Returns the number of events processed. Returns immediately |
1127 | regularly. Returns C<0> if all events could be processed, or C<-1> if it |
|
|
1128 | returned earlier for whatever reason. Returns immediately when no events |
1123 | when no events are outstanding. The amount of events processed depends on |
1129 | are outstanding. The amount of events processed depends on the settings of |
1124 | the settings of C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>. |
1130 | C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>. |
1125 | |
1131 | |
1126 | If not all requests were processed for whatever reason, the filehandle |
1132 | If not all requests were processed for whatever reason, the filehandle |
1127 | will still be ready when C<poll_cb> returns. |
1133 | will still be ready when C<poll_cb> returns, so normally you don't have to |
|
|
1134 | do anything special to have it called later. |
1128 | |
1135 | |
1129 | Example: Install an Event watcher that automatically calls |
1136 | Example: Install an Event watcher that automatically calls |
1130 | IO::AIO::poll_cb with high priority: |
1137 | IO::AIO::poll_cb with high priority: |
1131 | |
1138 | |
1132 | Event->io (fd => IO::AIO::poll_fileno, |
1139 | Event->io (fd => IO::AIO::poll_fileno, |