… | |
… | |
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.07'; |
198 | our $VERSION = '3.19'; |
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 | |
… | |
… | |
336 | |
338 | |
337 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
339 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
338 | |
340 | |
339 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
341 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
340 | |
342 | |
341 | Reads or writes C<$length> bytes from the specified C<$fh> and C<$offset> |
343 | Reads or writes C<$length> bytes from or to the specified C<$fh> and |
342 | into the scalar given by C<$data> and offset C<$dataoffset> and calls the |
344 | C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> |
343 | callback without the actual number of bytes read (or -1 on error, just |
345 | and calls the callback without the actual number of bytes read (or -1 on |
344 | like the syscall). |
346 | error, just like the syscall). |
|
|
347 | |
|
|
348 | C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to |
|
|
349 | offset plus the actual number of bytes read. |
345 | |
350 | |
346 | If C<$offset> is undefined, then the current file descriptor offset will |
351 | If C<$offset> is undefined, then the current file descriptor offset will |
347 | be used (and updated), otherwise the file descriptor offset will not be |
352 | be used (and updated), otherwise the file descriptor offset will not be |
348 | changed by these calls. |
353 | changed by these calls. |
349 | |
354 | |
350 | If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>. |
355 | If C<$length> is undefined in C<aio_write>, use the remaining length of |
|
|
356 | C<$data>. |
351 | |
357 | |
352 | If C<$dataoffset> is less than zero, it will be counted from the end of |
358 | If C<$dataoffset> is less than zero, it will be counted from the end of |
353 | C<$data>. |
359 | C<$data>. |
354 | |
360 | |
355 | The C<$data> scalar I<MUST NOT> be modified in any way while the request |
361 | The C<$data> scalar I<MUST NOT> be modified in any way while the request |
… | |
… | |
565 | |
571 | |
566 | Try to copy the I<file> (directories not supported as either source or |
572 | 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 |
573 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
568 | the C<0> (error) or C<-1> ok. |
574 | the C<0> (error) or C<-1> ok. |
569 | |
575 | |
570 | This is a composite request that it creates the destination file with |
576 | 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 |
577 | 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 |
578 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
573 | uid/gid, in that order. |
579 | uid/gid, in that order. |
574 | |
580 | |
575 | If an error occurs, the partial destination file will be unlinked, if |
581 | If an error occurs, the partial destination file will be unlinked, if |
… | |
… | |
631 | |
637 | |
632 | Try to move the I<file> (directories not supported as either source or |
638 | 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 |
639 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
634 | the C<0> (error) or C<-1> ok. |
640 | the C<0> (error) or C<-1> ok. |
635 | |
641 | |
636 | This is a composite request that tries to rename(2) the file first. If |
642 | 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 |
643 | rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if |
638 | that is successful, unlinking the C<$srcpath>. |
644 | that is successful, unlinks the C<$srcpath>. |
639 | |
645 | |
640 | =cut |
646 | =cut |
641 | |
647 | |
642 | sub aio_move($$;$) { |
648 | sub aio_move($$;$) { |
643 | my ($src, $dst, $cb) = @_; |
649 | my ($src, $dst, $cb) = @_; |
… | |
… | |
855 | callback with the fdatasync result code. |
861 | callback with the fdatasync result code. |
856 | |
862 | |
857 | If this call isn't available because your OS lacks it or it couldn't be |
863 | 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. |
864 | detected, it will be emulated by calling C<fsync> instead. |
859 | |
865 | |
|
|
866 | =item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
|
|
867 | |
|
|
868 | Sync the data portion of the file specified by C<$offset> and C<$length> |
|
|
869 | to disk (but NOT the metadata), by calling the Linux-specific |
|
|
870 | sync_file_range call. If sync_file_range is not available or it returns |
|
|
871 | ENOSYS, then fdatasync or fsync is being substituted. |
|
|
872 | |
|
|
873 | C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>, |
|
|
874 | C<IO::AIO::SYNC_FILE_RANGE_WRITE> and |
|
|
875 | C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range |
|
|
876 | manpage for details. |
|
|
877 | |
860 | =item aio_pathsync $path, $callback->($status) |
878 | =item aio_pathsync $path, $callback->($status) |
861 | |
879 | |
862 | This request tries to open, fsync and close the given path. This is a |
880 | This request tries to open, fsync and close the given path. This is a |
863 | composite request intended tosync directories after directory operations |
881 | composite request intended to sync directories after directory operations |
864 | (E.g. rename). This might not work on all operating systems or have any |
882 | (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 |
883 | 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, |
884 | written to disc. It works for anything that can be opened for read-only, |
867 | not just directories. |
885 | not just directories. |
868 | |
886 | |
… | |
… | |
1060 | =item feed $grp $callback->($grp) |
1078 | =item feed $grp $callback->($grp) |
1061 | |
1079 | |
1062 | Sets a feeder/generator on this group: every group can have an attached |
1080 | Sets a feeder/generator on this group: every group can have an attached |
1063 | generator that generates requests if idle. The idea behind this is that, |
1081 | generator that generates requests if idle. The idea behind this is that, |
1064 | although you could just queue as many requests as you want in a group, |
1082 | although you could just queue as many requests as you want in a group, |
1065 | this might starve other requests for a potentially long time. For |
1083 | this might starve other requests for a potentially long time. For example, |
1066 | example, C<aio_scandir> might generate hundreds of thousands C<aio_stat> |
1084 | C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests, |
1067 | requests, delaying any later requests for a long time. |
1085 | delaying any later requests for a long time. |
1068 | |
1086 | |
1069 | To avoid this, and allow incremental generation of requests, you can |
1087 | To avoid this, and allow incremental generation of requests, you can |
1070 | instead a group and set a feeder on it that generates those requests. The |
1088 | instead a group and set a feeder on it that generates those requests. The |
1071 | feed callback will be called whenever there are few enough (see C<limit>, |
1089 | feed callback will be called whenever there are few enough (see C<limit>, |
1072 | below) requests active in the group itself and is expected to queue more |
1090 | below) requests active in the group itself and is expected to queue more |
… | |
… | |
1076 | not impose any limits). |
1094 | not impose any limits). |
1077 | |
1095 | |
1078 | If the feed does not queue more requests when called, it will be |
1096 | If the feed does not queue more requests when called, it will be |
1079 | automatically removed from the group. |
1097 | automatically removed from the group. |
1080 | |
1098 | |
1081 | If the feed limit is C<0>, it will be set to C<2> automatically. |
1099 | If the feed limit is C<0> when this method is called, it will be set to |
|
|
1100 | C<2> automatically. |
1082 | |
1101 | |
1083 | Example: |
1102 | Example: |
1084 | |
1103 | |
1085 | # stat all files in @files, but only ever use four aio requests concurrently: |
1104 | # stat all files in @files, but only ever use four aio requests concurrently: |
1086 | |
1105 | |
… | |
… | |
1097 | |
1116 | |
1098 | Sets the feeder limit for the group: The feeder will be called whenever |
1117 | Sets the feeder limit for the group: The feeder will be called whenever |
1099 | the group contains less than this many requests. |
1118 | the group contains less than this many requests. |
1100 | |
1119 | |
1101 | Setting the limit to C<0> will pause the feeding process. |
1120 | Setting the limit to C<0> will pause the feeding process. |
|
|
1121 | |
|
|
1122 | The default value for the limit is C<0>, but note that setting a feeder |
|
|
1123 | automatically bumps it up to C<2>. |
1102 | |
1124 | |
1103 | =back |
1125 | =back |
1104 | |
1126 | |
1105 | =head2 SUPPORT FUNCTIONS |
1127 | =head2 SUPPORT FUNCTIONS |
1106 | |
1128 | |