ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/IO-AIO/AIO.pm
(Generate patch)

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.136 by root, Tue Sep 30 14:07:59 2008 UTC vs.
Revision 1.143 by root, Thu Nov 20 09:01:40 2008 UTC

193use strict 'vars'; 193use strict 'vars';
194 194
195use base 'Exporter'; 195use base 'Exporter';
196 196
197BEGIN { 197BEGIN {
198 our $VERSION = '3.1'; 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
214 push @AIO_REQ, qw(aio_busy); # not exported
213 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);
631 633
632Try to move the I<file> (directories not supported as either source or 634Try to move the I<file> (directories not supported as either source or
633destination) from C<$srcpath> to C<$dstpath> and call the callback with 635destination) from C<$srcpath> to C<$dstpath> and call the callback with
634the C<0> (error) or C<-1> ok. 636the C<0> (error) or C<-1> ok.
635 637
636This is a composite request that tries to rename(2) the file first. If 638This is a composite request that tries to rename(2) the file first; if
637rename files with C<EXDEV>, it copies the file with C<aio_copy> and, if 639rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if
638that is successful, unlinking the C<$srcpath>. 640that is successful, unlinks the C<$srcpath>.
639 641
640=cut 642=cut
641 643
642sub aio_move($$;$) { 644sub aio_move($$;$) {
643 my ($src, $dst, $cb) = @_; 645 my ($src, $dst, $cb) = @_;
855callback with the fdatasync result code. 857callback with the fdatasync result code.
856 858
857If this call isn't available because your OS lacks it or it couldn't be 859If this call isn't available because your OS lacks it or it couldn't be
858detected, it will be emulated by calling C<fsync> instead. 860detected, it will be emulated by calling C<fsync> instead.
859 861
862=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
863
864Sync the data portion of the file specified by C<$offset> and C<$length>
865to disk (but NOT the metadata), by calling the Linux-specific
866sync_file_range call. If sync_file_range is not available or it returns
867ENOSYS, then fdatasync or fsync is being substituted.
868
869C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,
870C<IO::AIO::SYNC_FILE_RANGE_WRITE> and
871C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range
872manpage for details.
873
860=item aio_pathsync $path, $callback->($status) 874=item aio_pathsync $path, $callback->($status)
861 875
862This request tries to open, fsync and close the given path. This is a 876This request tries to open, fsync and close the given path. This is a
863composite request intended to sync directories after directory operations 877composite 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
1060=item feed $grp $callback->($grp) 1074=item feed $grp $callback->($grp)
1061 1075
1062Sets a feeder/generator on this group: every group can have an attached 1076Sets a feeder/generator on this group: every group can have an attached
1063generator that generates requests if idle. The idea behind this is that, 1077generator that generates requests if idle. The idea behind this is that,
1064although you could just queue as many requests as you want in a group, 1078although you could just queue as many requests as you want in a group,
1065this might starve other requests for a potentially long time. For 1079this might starve other requests for a potentially long time. For example,
1066example, C<aio_scandir> might generate hundreds of thousands C<aio_stat> 1080C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests,
1067requests, delaying any later requests for a long time. 1081delaying any later requests for a long time.
1068 1082
1069To avoid this, and allow incremental generation of requests, you can 1083To avoid this, and allow incremental generation of requests, you can
1070instead a group and set a feeder on it that generates those requests. The 1084instead a group and set a feeder on it that generates those requests. The
1071feed callback will be called whenever there are few enough (see C<limit>, 1085feed callback will be called whenever there are few enough (see C<limit>,
1072below) requests active in the group itself and is expected to queue more 1086below) requests active in the group itself and is expected to queue more
1076not impose any limits). 1090not impose any limits).
1077 1091
1078If the feed does not queue more requests when called, it will be 1092If the feed does not queue more requests when called, it will be
1079automatically removed from the group. 1093automatically removed from the group.
1080 1094
1081If the feed limit is C<0>, it will be set to C<2> automatically. 1095If the feed limit is C<0> when this method is called, it will be set to
1096C<2> automatically.
1082 1097
1083Example: 1098Example:
1084 1099
1085 # 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:
1086 1101
1097 1112
1098Sets the feeder limit for the group: The feeder will be called whenever 1113Sets the feeder limit for the group: The feeder will be called whenever
1099the group contains less than this many requests. 1114the group contains less than this many requests.
1100 1115
1101Setting the limit to C<0> will pause the feeding process. 1116Setting the limit to C<0> will pause the feeding process.
1117
1118The default value for the limit is C<0>, but note that setting a feeder
1119automatically bumps it up to C<2>.
1102 1120
1103=back 1121=back
1104 1122
1105=head2 SUPPORT FUNCTIONS 1123=head2 SUPPORT FUNCTIONS
1106 1124

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines