… | |
… | |
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.17'; |
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_sync_file_range aio_pathsync aio_readahead |
204 | aio_rename aio_link aio_move aio_copy aio_group |
204 | aio_rename aio_link aio_move aio_copy aio_group |
205 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
205 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
206 | aio_chmod aio_utime aio_truncate); |
206 | aio_chmod aio_utime aio_truncate); |
207 | |
207 | |
208 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
208 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
209 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
209 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
210 | min_parallel max_parallel max_idle |
210 | min_parallel max_parallel max_idle |
211 | nreqs nready npending nthreads |
211 | nreqs nready npending nthreads |
212 | max_poll_time max_poll_reqs); |
212 | max_poll_time max_poll_reqs); |
213 | |
213 | |
|
|
214 | push @AIO_REQ, qw(aio_busy); # not exported |
|
|
215 | |
214 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
216 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
215 | |
217 | |
216 | require XSLoader; |
218 | require XSLoader; |
217 | XSLoader::load ("IO::AIO", $VERSION); |
219 | XSLoader::load ("IO::AIO", $VERSION); |
218 | } |
220 | } |
… | |
… | |
224 | 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 |
225 | 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, |
226 | and they all accept an additional (and optional) C<$callback> argument |
228 | 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 |
229 | 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 |
230 | 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 |
231 | perl, which usually delivers "false") as its sole argument after the given |
230 | syscall has been executed asynchronously. |
232 | syscall has been executed asynchronously. |
231 | |
233 | |
232 | All functions expecting a filehandle keep a copy of the filehandle |
234 | All functions expecting a filehandle keep a copy of the filehandle |
233 | internally until the request has finished. |
235 | internally until the request has finished. |
234 | |
236 | |
… | |
… | |
248 | 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 |
249 | 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) |
250 | use something else to ensure your scalar has the correct contents. |
252 | use something else to ensure your scalar has the correct contents. |
251 | |
253 | |
252 | 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 |
253 | handles correctly wether it is set or not. |
255 | handles correctly whether it is set or not. |
254 | |
256 | |
255 | =over 4 |
257 | =over 4 |
256 | |
258 | |
257 | =item $prev_pri = aioreq_pri [$pri] |
259 | =item $prev_pri = aioreq_pri [$pri] |
258 | |
260 | |
… | |
… | |
565 | |
567 | |
566 | 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 |
567 | 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 |
568 | the C<0> (error) or C<-1> ok. |
570 | the C<0> (error) or C<-1> ok. |
569 | |
571 | |
570 | This is a composite request that it creates the destination file with |
572 | 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 |
573 | 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 |
574 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
573 | uid/gid, in that order. |
575 | uid/gid, in that order. |
574 | |
576 | |
575 | 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 |
… | |
… | |
631 | |
633 | |
632 | 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 |
633 | 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 |
634 | the C<0> (error) or C<-1> ok. |
636 | the C<0> (error) or C<-1> ok. |
635 | |
637 | |
636 | 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 |
637 | 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 |
638 | that is successful, unlinking the C<$srcpath>. |
640 | that is successful, unlinks the C<$srcpath>. |
639 | |
641 | |
640 | =cut |
642 | =cut |
641 | |
643 | |
642 | sub aio_move($$;$) { |
644 | sub aio_move($$;$) { |
643 | my ($src, $dst, $cb) = @_; |
645 | my ($src, $dst, $cb) = @_; |
… | |
… | |
855 | callback with the fdatasync result code. |
857 | callback with the fdatasync result code. |
856 | |
858 | |
857 | 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 |
858 | detected, it will be emulated by calling C<fsync> instead. |
860 | detected, it will be emulated by calling C<fsync> instead. |
859 | |
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 | |
860 | =item aio_pathsync $path, $callback->($status) |
874 | =item aio_pathsync $path, $callback->($status) |
861 | |
875 | |
862 | This request tries to open, fsync and close the given path. This is a |
876 | This request tries to open, fsync and close the given path. This is a |
863 | composite request intended tosync directories after directory operations |
877 | composite request intended to sync directories after directory operations |
864 | (E.g. rename). This might not work on all operating systems or have any |
878 | (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 |
879 | 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, |
880 | written to disc. It works for anything that can be opened for read-only, |
867 | not just directories. |
881 | not just directories. |
868 | |
882 | |
… | |
… | |
1013 | Their lifetime, simplified, looks like this: when they are empty, they |
1027 | 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 |
1028 | 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 |
1029 | C<done> state, they will also finish. Otherwise they will continue to |
1016 | exist. |
1030 | exist. |
1017 | |
1031 | |
1018 | 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 |
1019 | 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 |
1020 | 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 |
1021 | itself finish. |
1035 | further requests to the group. And only when all those requests have |
|
|
1036 | finished will the the group itself finish. |
1022 | |
1037 | |
1023 | =over 4 |
1038 | =over 4 |
1024 | |
1039 | |
1025 | =item add $grp ... |
1040 | =item add $grp ... |
1026 | |
1041 | |
… | |
… | |
1059 | =item feed $grp $callback->($grp) |
1074 | =item feed $grp $callback->($grp) |
1060 | |
1075 | |
1061 | 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 |
1062 | 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, |
1063 | 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, |
1064 | this might starve other requests for a potentially long time. For |
1079 | 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> |
1080 | C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests, |
1066 | requests, delaying any later requests for a long time. |
1081 | delaying any later requests for a long time. |
1067 | |
1082 | |
1068 | To avoid this, and allow incremental generation of requests, you can |
1083 | 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 |
1084 | 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>, |
1085 | 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 |
1086 | below) requests active in the group itself and is expected to queue more |
… | |
… | |
1075 | not impose any limits). |
1090 | not impose any limits). |
1076 | |
1091 | |
1077 | 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 |
1078 | automatically removed from the group. |
1093 | automatically removed from the group. |
1079 | |
1094 | |
1080 | 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. |
1081 | |
1097 | |
1082 | Example: |
1098 | Example: |
1083 | |
1099 | |
1084 | # 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: |
1085 | |
1101 | |
… | |
… | |
1097 | 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 |
1098 | the group contains less than this many requests. |
1114 | the group contains less than this many requests. |
1099 | |
1115 | |
1100 | Setting the limit to C<0> will pause the feeding process. |
1116 | Setting the limit to C<0> will pause the feeding process. |
1101 | |
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 | |
1102 | =back |
1121 | =back |
1103 | |
1122 | |
1104 | =head2 SUPPORT FUNCTIONS |
1123 | =head2 SUPPORT FUNCTIONS |
1105 | |
1124 | |
1106 | =head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION |
1125 | =head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION |
… | |
… | |
1117 | See C<poll_cb> for an example. |
1136 | See C<poll_cb> for an example. |
1118 | |
1137 | |
1119 | =item IO::AIO::poll_cb |
1138 | =item IO::AIO::poll_cb |
1120 | |
1139 | |
1121 | 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 |
1122 | 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 |
1123 | 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 |
1124 | 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>. |
1125 | |
1145 | |
1126 | If not all requests were processed for whatever reason, the filehandle |
1146 | If not all requests were processed for whatever reason, the filehandle |
1127 | 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. |
1128 | |
1149 | |
1129 | Example: Install an Event watcher that automatically calls |
1150 | Example: Install an Event watcher that automatically calls |
1130 | IO::AIO::poll_cb with high priority: |
1151 | IO::AIO::poll_cb with high priority: |
1131 | |
1152 | |
1132 | Event->io (fd => IO::AIO::poll_fileno, |
1153 | Event->io (fd => IO::AIO::poll_fileno, |